{ "smithy": "2.0", "shapes": { "com.amazonaws.uxc#AWSAccountUXSetting": { "type": "service", "version": "2024-07-01", "operations": [ { "target": "com.amazonaws.uxc#GetAccountCustomizations" }, { "target": "com.amazonaws.uxc#ListServices" }, { "target": "com.amazonaws.uxc#UpdateAccountCustomizations" } ], "traits": { "aws.api#service": { "sdkId": "uxc", "arnNamespace": "uxc", "cloudFormationName": "AWSAccountUXSetting", "endpointPrefix": "uxc" }, "aws.auth#sigv4": { "name": "uxc" }, "aws.endpoints#dualStackOnlyEndpoints": {}, "aws.endpoints#standardRegionalEndpoints": {}, "aws.protocols#restJson1": {}, "smithy.api#cors": { "maxAge": 86400, "additionalAllowedHeaders": [ "Authorization", "Date", "X-Amz-Date", "X-Amz-Security-Token", "X-Amz-Target", "Content-type", "x-amz-content-sha256", "x-amz-user-agent", "Access-Control-Allow-Origin" ] }, "smithy.api#documentation": "
This is the Amazon Web Services User Experience Customization (UXC) API Reference. Amazon Web Services User Experience Customization (UXC) is a utility that provides programmatic access to enable account administrators to customize the visual appearance of the Amazon Web Services Management Console and manage these settings at the account level.
The visibleServices and visibleRegions settings control only the appearance of services and Regions in the Amazon Web Services Management Console. They do not restrict access through the CLI, SDKs, or other APIs.
For more information about UXC features and console procedures, see Getting started with Amazon Web Services User Experience Customization. For information about required permissions, see Identity and access management for Amazon Web Services Management Console.
", "smithy.api#title": "AWS User Experience Customization", "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" }, "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://uxc-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://uxc.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 6, "nodes": "/////wAAAAH/////AAAAAAAAAAYAAAADAAAAAQAAAAQF9eEFAAAAAgAAAAUF9eEFAAAAAwX14QMF9eEEAAAAAwX14QEF9eEC" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" }, "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "endpoint": { "url": "https://uxc-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://uxc.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "type": "tree" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For custom endpoint with region not set and fips disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Endpoint": "https://example.com", "UseFIPS": false } }, { "documentation": "For custom endpoint with fips enabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Endpoint": "https://example.com", "UseFIPS": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://uxc-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://uxc.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false } }, { "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://uxc-fips.cn-northwest-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": true } }, { "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://uxc.cn-northwest-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": false } }, { "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://uxc-fips.us-gov-west-1.api.aws" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": true } }, { "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://uxc.us-gov-west-1.api.aws" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": false } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } }, "com.amazonaws.uxc#AccessDeniedException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "You don't have sufficient access to perform this operation. Verify that your IAM policy includes the required uxc: permissions for the operation that you are calling. For more information on IAM permissions, see Amazon Web Services managed policies for Amazon Web Services Management Console.
Returns the current account customization settings, including account color, visible services, and visible Regions. Settings that you have not configured return their default values: visible Regions and visible services return `null`, and account color returns `none`.
The visibleServices and visibleRegions settings control only the appearance of services and Regions in the Amazon Web Services Management Console. They do not restrict access through the CLI, SDKs, or other APIs.
The account color preference. A value of none indicates that you have not set a color.
The list of Amazon Web Services service identifiers that are visible to the account in the Amazon Web Services Management Console. A value of null indicates that you have not configured this feature and all services are visible. For valid service identifiers, call ListServices.
The list of Amazon Web Services Region codes that are visible to the account in the Amazon Web Services Management Console. A value of null indicates that you have not configured this feature and all Regions are visible. For a list of valid Region codes, see Amazon Web Services Regions.
The service encountered an internal error. Try your request again later.
", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.uxc#ListServices": { "type": "operation", "input": { "target": "com.amazonaws.uxc#ListServicesInput" }, "output": { "target": "com.amazonaws.uxc#ListServicesOutput" }, "errors": [ { "target": "com.amazonaws.uxc#AccessDeniedException" }, { "target": "com.amazonaws.uxc#InternalServerException" }, { "target": "com.amazonaws.uxc#ThrottlingException" }, { "target": "com.amazonaws.uxc#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to list available services" }, "smithy.api#documentation": "Returns a paginated list of Amazon Web Services service identifiers that you can use as values for the visibleServices setting in UpdateAccountCustomizations. The available services vary by Amazon Web Services partition. Use pagination to retrieve all results.
The visibleServices setting controls only the appearance of services in the Amazon Web Services Management Console. It does not restrict access through the CLI, SDKs, or other APIs.
The token for retrieving the next page of results. Use the nextToken value from a previous response.
The maximum number of results to return per page.
", "smithy.api#httpQuery": "maxResults" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.uxc#ListServicesOutput": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.uxc#NextToken", "traits": { "smithy.api#documentation": "The token for retrieving the next page of results. This value is null when no more results are available.
The list of available Amazon Web Services service identifiers.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.uxc#MaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 1000 } } }, "com.amazonaws.uxc#NextToken": { "type": "string", "traits": { "smithy.api#length": { "min": 32, "max": 512 }, "smithy.api#pattern": "^[-A-Za-z0-9+/_]+=*$" } }, "com.amazonaws.uxc#Region": { "type": "string", "traits": { "smithy.api#pattern": "^[a-z]{2}(-[a-z]{1,10}){1,2}-[1-9]$" } }, "com.amazonaws.uxc#RegionsList": { "type": "list", "member": { "target": "com.amazonaws.uxc#Region" }, "traits": { "smithy.api#length": { "max": 100 } } }, "com.amazonaws.uxc#Service": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[a-z0-9]+(-[a-z0-9]+)*$" } }, "com.amazonaws.uxc#ServiceList": { "type": "list", "member": { "target": "com.amazonaws.uxc#Service" }, "traits": { "smithy.api#length": { "max": 500 } } }, "com.amazonaws.uxc#ThrottlingException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request was denied because of request throttling. Reduce the frequency of your requests.
", "smithy.api#error": "client", "smithy.api#httpError": 429 } }, "com.amazonaws.uxc#UpdateAccountCustomizations": { "type": "operation", "input": { "target": "com.amazonaws.uxc#UpdateAccountCustomizationsInput" }, "output": { "target": "com.amazonaws.uxc#UpdateAccountCustomizationsOutput" }, "errors": [ { "target": "com.amazonaws.uxc#AccessDeniedException" }, { "target": "com.amazonaws.uxc#InternalServerException" }, { "target": "com.amazonaws.uxc#ThrottlingException" }, { "target": "com.amazonaws.uxc#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to update account customizations" }, "smithy.api#documentation": "Updates one or more account customization settings. You can update account color, visible services, and visible Regions in a single request. Only the settings that you include in the request body are modified. Omitted settings remain unchanged. To reset a setting to its default behavior, set the value to null for visible Regions and visible services, or none for account color. This operation is idempotent.
The visibleServices and visibleRegions settings control only the appearance of services and Regions in the Amazon Web Services Management Console. They do not restrict access through the CLI, SDKs, or other APIs.
The account color preference to set. Set to none to reset to the default (no color).
The list of Amazon Web Services service identifiers to make visible in the Amazon Web Services Management Console. Set to null to reset to the default, which makes all services visible. For valid service identifiers, call ListServices.
The list of Amazon Web Services Region codes to make visible in the Amazon Web Services Management Console. Set to null to reset to the default, which makes all Regions visible. For a list of valid Region codes, see Amazon Web Services Regions.
The current account color preference after the update.
" } }, "visibleServices": { "target": "com.amazonaws.uxc#ServiceList", "traits": { "smithy.api#documentation": "The current list of visible service identifiers after the update.
" } }, "visibleRegions": { "target": "com.amazonaws.uxc#RegionsList", "traits": { "smithy.api#documentation": "The current list of visible Region codes after the update.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.uxc#ValidationException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } }, "fieldList": { "target": "com.amazonaws.uxc#ValidationExceptionFieldList", "traits": { "smithy.api#documentation": "The list of fields that are invalid.
" } } }, "traits": { "smithy.api#documentation": "The input fails to satisfy the constraints specified by an Amazon Web Services service.
", "smithy.api#error": "client" } }, "com.amazonaws.uxc#ValidationExceptionField": { "type": "structure", "members": { "path": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The field name with the validation exception.
", "smithy.api#required": {} } }, "message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A message describing the validation exception.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Describes a validation exception for a specific field.
" } }, "com.amazonaws.uxc#ValidationExceptionFieldList": { "type": "list", "member": { "target": "com.amazonaws.uxc#ValidationExceptionField" } } } }