Location of the Amazon S3 manifest file. This is NULL if the manifest file was\n uploaded into Amazon QuickSight.
", "smithy.api#required": {} } + }, + "RoleArn": { + "target": "com.amazonaws.quicksight#RoleArn", + "traits": { + "smithy.api#documentation": "Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
Adds the resource mapping for the draft application version.
", + "smithy.api#documentation": "Adds the resource mapping for the draft application version. You can also update an existing resource mapping to a new physical resource.
", "smithy.api#http": { "method": "POST", "uri": "/add-draft-app-version-resource-mappings", @@ -57,14 +57,14 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
Mappings used to map logical resources from the template to physical resources. You can\n use the mapping type CFN_STACK if the application template uses\n a logical stack name. Or you can map individual resources by using the mapping type\n RESOURCE. We recommend using the mapping type CFN_STACK if the\n application is backed by a CloudFormation stack.
Mappings used to map logical resources from the template to physical resources. You can\n use the mapping type CFN_STACK if the application template uses\n a logical stack name. Or you can map individual resources by using the mapping type\n RESOURCE. We recommend using the mapping type CFN_STACK if the\n application is backed by a CloudFormation stack.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
The application component for the CloudWatch alarm recommendation.
" + "smithy.api#documentation": "The Application Component for the CloudWatch alarm recommendation.
" } }, "items": { @@ -207,7 +228,7 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: \narn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: \narn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
Defines a Resilience Hub application.
" + "smithy.api#documentation": "Defines an AWS Resilience Hub application.
" } }, "com.amazonaws.resiliencehub#AppAssessment": { @@ -291,7 +312,7 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
The name of the application component.
", + "smithy.api#documentation": "The name of the Application Component.
", "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.resiliencehub#String255", "traits": { - "smithy.api#documentation": "The type of application component.
", + "smithy.api#documentation": "The type of Application Component.
", "smithy.api#required": {} } + }, + "id": { + "target": "com.amazonaws.resiliencehub#String255", + "traits": { + "smithy.api#documentation": "Unique identifier of the Application Component.
" + } + }, + "additionalInfo": { + "target": "com.amazonaws.resiliencehub#AdditionalInfoMap", + "traits": { + "smithy.api#documentation": "Additional configuration parameters for an AWS Resilience Hub application.
\nCurrently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.
\nKey: \"failover-regions\"\n
Value: \"[{\"region\":\"<REGION>\", \"accounts\":[{\"id\":\"<ACCOUNT_ID>\"}]}]\"\n
Defines an application component.
" + "smithy.api#documentation": "Defines an Application Component.
" } }, "com.amazonaws.resiliencehub#AppComponentCompliance": { @@ -553,13 +586,13 @@ "appComponentName": { "target": "com.amazonaws.resiliencehub#EntityId", "traits": { - "smithy.api#documentation": "The name of the application component.
" + "smithy.api#documentation": "The name of the Application Component.
" } }, "compliance": { "target": "com.amazonaws.resiliencehub#AssessmentCompliance", "traits": { - "smithy.api#documentation": "The compliance of the application component against the resiliency policy.
" + "smithy.api#documentation": "The compliance of the Application Component against the resiliency policy.
" } }, "message": { @@ -582,7 +615,7 @@ } }, "traits": { - "smithy.api#documentation": "Defines the compliance of an application component against the resiliency policy.
" + "smithy.api#documentation": "Defines the compliance of an Application Component against the resiliency policy.
" } }, "com.amazonaws.resiliencehub#AppComponentList": { @@ -591,6 +624,58 @@ "target": "com.amazonaws.resiliencehub#AppComponent" } }, + "com.amazonaws.resiliencehub#AppComponentNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.resiliencehub#String255" + } + }, + "com.amazonaws.resiliencehub#AppInputSource": { + "type": "structure", + "members": { + "sourceName": { + "target": "com.amazonaws.resiliencehub#String255", + "traits": { + "smithy.api#documentation": "The name of the input source.
" + } + }, + "importType": { + "target": "com.amazonaws.resiliencehub#ResourceMappingType", + "traits": { + "smithy.api#documentation": "The resource type of the input source.
", + "smithy.api#required": {} + } + }, + "sourceArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the input source. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
" + } + }, + "terraformSource": { + "target": "com.amazonaws.resiliencehub#TerraformSource", + "traits": { + "smithy.api#documentation": "The name of the Terraform s3 state file.
" + } + }, + "resourceCount": { + "target": "com.amazonaws.resiliencehub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of resources that were imported.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The list of AWS Resilience Hub application input sources.
" + } + }, + "com.amazonaws.resiliencehub#AppInputSourceList": { + "type": "list", + "member": { + "target": "com.amazonaws.resiliencehub#AppInputSource" + } + }, "com.amazonaws.resiliencehub#AppStatusType": { "type": "string", "traits": { @@ -612,7 +697,7 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
The name of the application component.
", + "smithy.api#documentation": "The name of the Application Component.
", "smithy.api#required": {} } }, @@ -2380,7 +1967,7 @@ } }, "traits": { - "smithy.api#documentation": "Defines recommendations for a Resilience Hub application component, returned as an object. This\n object contains component names, configuration recommendations, and recommendation\n statuses.
" + "smithy.api#documentation": "Defines recommendations for an AWS Resilience Hub Application Component, returned as an object. This\n object contains component names, configuration recommendations, and recommendation\n statuses.
" } }, "com.amazonaws.resiliencehub#ComponentRecommendationList": { @@ -2401,7 +1988,7 @@ "appComponentName": { "target": "com.amazonaws.resiliencehub#EntityId", "traits": { - "smithy.api#documentation": "The application component name.
" + "smithy.api#documentation": "The name of the Application Component.
" } }, "compliance": { @@ -2517,7 +2104,7 @@ } }, "traits": { - "smithy.api#documentation": "Occurs when a conflict with a previous successful write is detected. This generally occurs\n when the previous write did not have time to propagate to the host serving the current\n request. A retry (with appropriate backoff logic) is the recommended response to this\n exception.
", + "smithy.api#documentation": "This exception occurs when a conflict with a previous successful write is detected. This generally occurs\n when the previous write did not have time to propagate to the host serving the current\n request. A retry (with appropriate backoff logic) is the recommended response to this\n exception.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -2607,7 +2194,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a Resilience Hub application. A Resilience Hub application is a collection of Amazon Web Services\n resources structured to prevent and recover Amazon Web Services application disruptions. To describe a\n Resilience Hub application, you provide an application name, resources from one or more–up to\n five–CloudFormation stacks, and an appropriate resiliency policy.
\nAfter you create a Resilience Hub application, you publish it so that you can run a resiliency\n assessment on it. You can then use recommendations from the assessment to improve resiliency\n by running another assessment, comparing results, and then iterating the process until you\n achieve your goals for recovery time objective (RTO) and recovery point objective\n (RPO).
", + "smithy.api#documentation": "Creates an AWS Resilience Hub application. An AWS Resilience Hub application is a collection of Amazon Web Services\n resources structured to prevent and recover Amazon Web Services application disruptions. To describe a\n AWS Resilience Hub application, you provide an application name, resources from one or more–up to\n five–CloudFormation stacks, and an appropriate resiliency policy.
\nAfter you create an AWS Resilience Hub application, you publish it so that you can run a resiliency\n assessment on it. You can then use recommendations from the assessment to improve resiliency\n by running another assessment, comparing results, and then iterating the process until you\n achieve your goals for recovery time objective (RTO) and recovery point objective\n (RPO).
", "smithy.api#http": { "method": "POST", "uri": "/create-app", @@ -2621,26 +2208,263 @@ "name": { "target": "com.amazonaws.resiliencehub#EntityName", "traits": { - "smithy.api#documentation": "The name for the application.
", + "smithy.api#documentation": "The name for the application.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.resiliencehub#EntityDescription", + "traits": { + "smithy.api#documentation": "The optional description for an app.
" + } + }, + "policyArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: \narn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. \nEach tag consists of a key/value pair.
" + } + }, + "clientToken": { + "target": "com.amazonaws.resiliencehub#ClientToken", + "traits": { + "smithy.api#documentation": "Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. \nYou should not reuse the same client token for other API requests.
", + "smithy.api#idempotencyToken": {} + } + }, + "assessmentSchedule": { + "target": "com.amazonaws.resiliencehub#AppAssessmentScheduleType", + "traits": { + "smithy.api#documentation": "\n Assessment execution schedule with 'Daily' or 'Disabled' values.\n
" + } + } + } + }, + "com.amazonaws.resiliencehub#CreateAppResponse": { + "type": "structure", + "members": { + "app": { + "target": "com.amazonaws.resiliencehub#App", + "traits": { + "smithy.api#documentation": "The created application returned as an object with details including compliance status,\n creation time, description, resiliency score, and more.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.resiliencehub#CreateAppVersionAppComponent": { + "type": "operation", + "input": { + "target": "com.amazonaws.resiliencehub#CreateAppVersionAppComponentRequest" + }, + "output": { + "target": "com.amazonaws.resiliencehub#CreateAppVersionAppComponentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.resiliencehub#AccessDeniedException" + }, + { + "target": "com.amazonaws.resiliencehub#ConflictException" + }, + { + "target": "com.amazonaws.resiliencehub#InternalServerException" + }, + { + "target": "com.amazonaws.resiliencehub#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.resiliencehub#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.resiliencehub#ThrottlingException" + }, + { + "target": "com.amazonaws.resiliencehub#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a new Application Component in the AWS Resilience Hub application.
\nThis API updates the AWS Resilience Hub application draft version. To use this Application Component for running assessments, you must publish the AWS Resilience Hub application using the PublishAppVersion API.
The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
The identifier of the Application Component.
" + } + }, + "name": { + "target": "com.amazonaws.resiliencehub#String255", + "traits": { + "smithy.api#documentation": "The name of the Application Component.
", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.resiliencehub#String255", + "traits": { + "smithy.api#documentation": "The type of Application Component. For more information about the types of Application Component, see Grouping resources in an AppComponent.
", + "smithy.api#required": {} + } + }, + "additionalInfo": { + "target": "com.amazonaws.resiliencehub#AdditionalInfoMap", + "traits": { + "smithy.api#documentation": "Currently, there is no supported additional information for Application Components.
" + } + }, + "clientToken": { + "target": "com.amazonaws.resiliencehub#ClientToken", + "traits": { + "smithy.api#documentation": "Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. \nYou should not reuse the same client token for other API requests.
", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.resiliencehub#CreateAppVersionAppComponentResponse": { + "type": "structure", + "members": { + "appArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
The AWS Resilience Hub application version.
", + "smithy.api#required": {} + } + }, + "appComponent": { + "target": "com.amazonaws.resiliencehub#AppComponent" + } + } + }, + "com.amazonaws.resiliencehub#CreateAppVersionResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.resiliencehub#CreateAppVersionResourceRequest" + }, + "output": { + "target": "com.amazonaws.resiliencehub#CreateAppVersionResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.resiliencehub#AccessDeniedException" + }, + { + "target": "com.amazonaws.resiliencehub#ConflictException" + }, + { + "target": "com.amazonaws.resiliencehub#InternalServerException" + }, + { + "target": "com.amazonaws.resiliencehub#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.resiliencehub#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.resiliencehub#ThrottlingException" + }, + { + "target": "com.amazonaws.resiliencehub#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Adds a resource to the AWS Resilience Hub applicationand assigns it to the specified\n Application Components. If you specify a new Application Component, AWS Resilience Hub will automatically\n create the Application Component.
\nThis action has no effect outside AWS Resilience Hub.
\nThis API updates the AWS Resilience Hub application draft version. To use this resource\n for running resiliency assessments, you must publish the AWS Resilience Hub application using\n the PublishAppVersion API.
To update application version with new physicalResourceID, you must\n call ResolveAppVersionResources API.
The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
The name of the resource.
", + "smithy.api#required": {} + } + }, + "logicalResourceId": { + "target": "com.amazonaws.resiliencehub#LogicalResourceId", + "traits": { + "smithy.api#documentation": "The logical identifier of the resource.
", "smithy.api#required": {} } }, - "description": { - "target": "com.amazonaws.resiliencehub#EntityDescription", + "physicalResourceId": { + "target": "com.amazonaws.resiliencehub#String2048", "traits": { - "smithy.api#documentation": "The optional description for an app.
" + "smithy.api#documentation": "The physical identifier of the resource.
", + "smithy.api#required": {} } }, - "policyArn": { - "target": "com.amazonaws.resiliencehub#Arn", + "awsRegion": { + "target": "com.amazonaws.resiliencehub#AwsRegion", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: \narn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Web Services region that owns the physical resource.
" } }, - "tags": { - "target": "com.amazonaws.resiliencehub#TagMap", + "awsAccountId": { + "target": "com.amazonaws.resiliencehub#CustomerId", "traits": { - "smithy.api#documentation": "The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. \nEach tag consists of a key/value pair.
" + "smithy.api#documentation": "The Amazon Web Services account that owns the physical resource.
" + } + }, + "resourceType": { + "target": "com.amazonaws.resiliencehub#String255", + "traits": { + "smithy.api#documentation": "The type of resource.
", + "smithy.api#required": {} + } + }, + "appComponents": { + "target": "com.amazonaws.resiliencehub#AppComponentNameList", + "traits": { + "smithy.api#documentation": "The list of Application Components that this resource belongs to. If an Application Component is not part of the AWS Resilience Hub application, it will be added.
", + "smithy.api#required": {} + } + }, + "additionalInfo": { + "target": "com.amazonaws.resiliencehub#AdditionalInfoMap", + "traits": { + "smithy.api#documentation": "Currently, there is no supported additional information for resources.
" } }, "clientToken": { @@ -2649,24 +2473,31 @@ "smithy.api#documentation": "Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. \nYou should not reuse the same client token for other API requests.
", "smithy.api#idempotencyToken": {} } - }, - "assessmentSchedule": { - "target": "com.amazonaws.resiliencehub#AppAssessmentScheduleType", - "traits": { - "smithy.api#documentation": "\n Assessment execution schedule with 'Daily' or 'Disabled' values.\n
" - } } } }, - "com.amazonaws.resiliencehub#CreateAppResponse": { + "com.amazonaws.resiliencehub#CreateAppVersionResourceResponse": { "type": "structure", "members": { - "app": { - "target": "com.amazonaws.resiliencehub#App", + "appArn": { + "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "The created application returned as an object with details including compliance status,\n creation time, description, resiliency score, and more.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
The AWS Resilience Hub application version.
", "smithy.api#required": {} } + }, + "physicalResource": { + "target": "com.amazonaws.resiliencehub#PhysicalResource", + "traits": { + "smithy.api#documentation": "Defines a physical resource. A physical resource is a resource that exists in your account. It can be identified using an Amazon Resource Name (ARN) or a Resilience Hub-native identifier.
" + } } } }, @@ -2691,6 +2522,9 @@ { "target": "com.amazonaws.resiliencehub#ResourceNotFoundException" }, + { + "target": "com.amazonaws.resiliencehub#ServiceQuotaExceededException" + }, { "target": "com.amazonaws.resiliencehub#ThrottlingException" }, @@ -2699,7 +2533,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new recommendation template.
", + "smithy.api#documentation": "Creates a new recommendation template for the AWS Resilience Hub application.
", "smithy.api#http": { "method": "POST", "uri": "/create-recommendation-template", @@ -2731,7 +2565,7 @@ "assessmentArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
Deletes the input source and all of its imported resources from the AWS Resilience Hub application.
", + "smithy.api#http": { + "method": "POST", + "uri": "/delete-app-input-source", + "code": 200 + } + } + }, + "com.amazonaws.resiliencehub#DeleteAppInputSourceRequest": { + "type": "structure", + "members": { + "appArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
The Amazon Resource Name (ARN) of the imported resource you want to remove from the\n AWS Resilience Hub application. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
" + } + }, + "terraformSource": { + "target": "com.amazonaws.resiliencehub#TerraformSource", + "traits": { + "smithy.api#documentation": "The imported Terraform s3 state file you want to remove from the AWS Resilience Hub application.
" + } + }, + "clientToken": { + "target": "com.amazonaws.resiliencehub#ClientToken", + "traits": { + "smithy.api#documentation": "Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. \nYou should not reuse the same client token for other API requests.
", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.resiliencehub#DeleteAppInputSourceResponse": { + "type": "structure", + "members": { + "appArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
The name of the input source from where the application resource is imported from.
" + } + } + } + }, + "com.amazonaws.resiliencehub#DeleteAppRequest": { + "type": "structure", + "members": { + "appArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
A boolean option to force the deletion of an AWS Resilience Hub application.
" + } + }, + "clientToken": { + "target": "com.amazonaws.resiliencehub#ClientToken", + "traits": { + "smithy.api#documentation": "Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. \nYou should not reuse the same client token for other API requests.
", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.resiliencehub#DeleteAppResponse": { + "type": "structure", + "members": { + "appArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
Deletes an Application Component from the AWS Resilience Hub application.
\nThis API updates the AWS Resilience Hub application draft version. To use this Application Component for running assessments, you must publish the AWS Resilience Hub application using the PublishAppVersion API.
You will not be able to delete an Application Component if it has resources associated with it.
\nThe Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
The identifier of the Application Component.
", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.resiliencehub#ClientToken", + "traits": { + "smithy.api#documentation": "Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. \nYou should not reuse the same client token for other API requests.
", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.resiliencehub#DeleteAppVersionAppComponentResponse": { + "type": "structure", + "members": { + "appArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
The AWS Resilience Hub application version.
", + "smithy.api#required": {} + } + }, + "appComponent": { + "target": "com.amazonaws.resiliencehub#AppComponent" + } + } + }, + "com.amazonaws.resiliencehub#DeleteAppVersionResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.resiliencehub#DeleteAppVersionResourceRequest" + }, + "output": { + "target": "com.amazonaws.resiliencehub#DeleteAppVersionResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.resiliencehub#AccessDeniedException" + }, + { + "target": "com.amazonaws.resiliencehub#ConflictException" + }, + { + "target": "com.amazonaws.resiliencehub#InternalServerException" + }, + { + "target": "com.amazonaws.resiliencehub#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.resiliencehub#ThrottlingException" + }, + { + "target": "com.amazonaws.resiliencehub#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a resource from the AWS Resilience Hub application.
\nYou can only delete a manually added resource. To exclude non-manually added resources, use the UpdateAppVersionResource API.
This action has no effect outside AWS Resilience Hub.
\nThis API updates the AWS Resilience Hub application draft version. To use this resource for running resiliency assessments, you must publish the AWS Resilience Hub application using the PublishAppVersion API.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
The name of the resource.
" + } + }, + "logicalResourceId": { + "target": "com.amazonaws.resiliencehub#LogicalResourceId", + "traits": { + "smithy.api#documentation": "The logical identifier of the resource.
" + } + }, + "physicalResourceId": { + "target": "com.amazonaws.resiliencehub#String2048", + "traits": { + "smithy.api#documentation": "The physical identifier of the resource.
" + } + }, + "awsRegion": { + "target": "com.amazonaws.resiliencehub#AwsRegion", + "traits": { + "smithy.api#documentation": "The Amazon Web Services region that owns the physical resource.
" + } + }, + "awsAccountId": { + "target": "com.amazonaws.resiliencehub#CustomerId", "traits": { - "smithy.api#documentation": "A boolean option to force the deletion of a Resilience Hub application.
" + "smithy.api#documentation": "The Amazon Web Services account that owns the physical resource.
" } }, "clientToken": { @@ -3042,15 +3144,28 @@ } } }, - "com.amazonaws.resiliencehub#DeleteAppResponse": { + "com.amazonaws.resiliencehub#DeleteAppVersionResourceResponse": { "type": "structure", "members": { "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
The AWS Resilience Hub application version.
", "smithy.api#required": {} } + }, + "physicalResource": { + "target": "com.amazonaws.resiliencehub#PhysicalResource", + "traits": { + "smithy.api#documentation": "Defines a physical resource. A physical resource is a resource that exists in your account. It can be identified using an Amazon Resource Name (ARN) or a Resilience Hub-native identifier.
" + } } } }, @@ -3169,7 +3284,7 @@ "policyArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: \narn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: \narn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: \narn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: \narn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
The assessment for an AWS Resilience Hub application, returned as an object. This object\n includes Amazon Resource Names (ARNs), compliance information, compliance status, cost,\n messages, resiliency scores, and more.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.resiliencehub#DescribeAppRequest": { + "type": "structure", + "members": { + "appArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
The specified application, returned as an object with details including compliance status,\n creation time, description, resiliency score, and more.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.resiliencehub#DescribeAppVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.resiliencehub#DescribeAppVersionRequest" + }, + "output": { + "target": "com.amazonaws.resiliencehub#DescribeAppVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.resiliencehub#AccessDeniedException" + }, + { + "target": "com.amazonaws.resiliencehub#InternalServerException" + }, + { + "target": "com.amazonaws.resiliencehub#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.resiliencehub#ThrottlingException" + }, + { + "target": "com.amazonaws.resiliencehub#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Describes the AWS Resilience Hub application version.
", + "smithy.api#http": { + "method": "POST", + "uri": "/describe-app-version", + "code": 200 + } + } + }, + "com.amazonaws.resiliencehub#DescribeAppVersionAppComponent": { + "type": "operation", + "input": { + "target": "com.amazonaws.resiliencehub#DescribeAppVersionAppComponentRequest" + }, + "output": { + "target": "com.amazonaws.resiliencehub#DescribeAppVersionAppComponentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.resiliencehub#AccessDeniedException" + }, + { + "target": "com.amazonaws.resiliencehub#ConflictException" + }, + { + "target": "com.amazonaws.resiliencehub#InternalServerException" + }, + { + "target": "com.amazonaws.resiliencehub#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.resiliencehub#ThrottlingException" + }, + { + "target": "com.amazonaws.resiliencehub#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Describes an Application Component in the AWS Resilience Hub application.
", + "smithy.api#http": { + "method": "POST", + "uri": "/describe-app-version-app-component", + "code": 200 + } + } + }, + "com.amazonaws.resiliencehub#DescribeAppVersionAppComponentRequest": { + "type": "structure", + "members": { + "appArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
The AWS Resilience Hub application version.
", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.resiliencehub#String255", + "traits": { + "smithy.api#documentation": "The identifier of the Application Component.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.resiliencehub#DescribeAppVersionAppComponentResponse": { + "type": "structure", + "members": { + "appArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
The AWS Resilience Hub application version.
", + "smithy.api#required": {} + } + }, + "appComponent": { + "target": "com.amazonaws.resiliencehub#AppComponent" + } + } + }, + "com.amazonaws.resiliencehub#DescribeAppVersionRequest": { + "type": "structure", + "members": { + "appArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
The AWS Resilience Hub application version.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.resiliencehub#DescribeAppVersionResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.resiliencehub#DescribeAppVersionResourceRequest" + }, + "output": { + "target": "com.amazonaws.resiliencehub#DescribeAppVersionResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.resiliencehub#AccessDeniedException" + }, + { + "target": "com.amazonaws.resiliencehub#ConflictException" + }, + { + "target": "com.amazonaws.resiliencehub#InternalServerException" + }, + { + "target": "com.amazonaws.resiliencehub#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.resiliencehub#ThrottlingException" + }, + { + "target": "com.amazonaws.resiliencehub#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Describes a resource of the AWS Resilience Hub application.
\nThis API accepts only one of the following parameters to descibe the resource:
\n\n resourceName\n
\n logicalResourceId\n
\n physicalResourceId (Along with physicalResourceId, you can also\n provide awsAccountId, and awsRegion)
The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
The AWS Resilience Hub application version.
", + "smithy.api#required": {} + } + }, + "resourceName": { + "target": "com.amazonaws.resiliencehub#EntityName", + "traits": { + "smithy.api#documentation": "The name of the resource.
" + } + }, + "logicalResourceId": { + "target": "com.amazonaws.resiliencehub#LogicalResourceId", + "traits": { + "smithy.api#documentation": "The logical identifier of the resource.
" + } + }, + "physicalResourceId": { + "target": "com.amazonaws.resiliencehub#String2048", + "traits": { + "smithy.api#documentation": "The physical identifier of the resource.
" } - } - } - }, - "com.amazonaws.resiliencehub#DescribeAppAssessmentResponse": { - "type": "structure", - "members": { - "assessment": { - "target": "com.amazonaws.resiliencehub#AppAssessment", + }, + "awsRegion": { + "target": "com.amazonaws.resiliencehub#AwsRegion", "traits": { - "smithy.api#documentation": "The assessment for an AWS Resilience Hub application, returned as an object. This object\n includes Amazon Resource Names (ARNs), compliance information, compliance status, cost,\n messages, resiliency scores, and more.
", - "smithy.api#required": {} + "smithy.api#documentation": "The Amazon Web Services region that owns the physical resource.
" + } + }, + "awsAccountId": { + "target": "com.amazonaws.resiliencehub#CustomerId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account that owns the physical resource.
" } } } }, - "com.amazonaws.resiliencehub#DescribeAppRequest": { + "com.amazonaws.resiliencehub#DescribeAppVersionResourceResponse": { "type": "structure", "members": { "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
The specified application, returned as an object with details including compliance status,\n creation time, description, resiliency score, and more.
", + "smithy.api#documentation": "The AWS Resilience Hub application version.
", "smithy.api#required": {} } + }, + "physicalResource": { + "target": "com.amazonaws.resiliencehub#PhysicalResource", + "traits": { + "smithy.api#documentation": "Defines a physical resource. A physical resource is a resource that exists in your account. It can be identified using an Amazon Resource Name (ARN) or a Resilience Hub-native identifier.
" + } } } }, @@ -3350,7 +3714,7 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
The AWS Resilience Hub application version.
", + "smithy.api#required": {} + } + }, + "additionalInfo": { + "target": "com.amazonaws.resiliencehub#AdditionalInfoMap", + "traits": { + "smithy.api#documentation": "Additional configuration parameters for an AWS Resilience Hub application.
\nCurrently, this parameter supports only failover region and account.
\nDescribes details about an AWS Resilience Hub
", + "smithy.api#documentation": "Describes details about an AWS Resilience Hub application.
", "smithy.api#http": { "method": "POST", "uri": "/describe-app-version-template", @@ -3448,7 +3837,7 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
The body of the template.
", + "smithy.api#documentation": "A JSON string that provides information about your application structure. To learn more\n about the appTemplateBody template, see the sample template provided in the\n Examples section.
The appTemplateBody JSON string has the following structure:
\n \n resources\n \n
The list of logical resources that needs to be included in the application.
\nType: Array
\nDon't add the resources that you want to exclude.
\nEach resources array item includes the following fields:
\n \n logicalResourceId\n \n
The logical identifier of the resource.
\nType: Object
\nEach logicalResourceId object includes the following fields:
\n identifier\n
The identifier of the resource.
\nType: String
\n\n logicalStackName\n
The name of the CloudFormation stack this resource belongs to.
\nType: String
\n\n resourceGroupName\n
The name of the resource group this resource belongs to.
\nType: String
\n\n terraformSourceName\n
The name of the Terraform S3 state file this resource belongs to.
\nType: String
\n\n \n type\n \n
The type of resource.
\nType: string
\n\n \n name\n \n
The name of the resource.
\nType: String
\n\n \n appComponents\n \n
The list of Application Components that this resource belongs to. If an Application Component is not part of the AWS Resilience Hub application, it will be added.
\nType: Array
\nEach appComponents array item includes the following fields:
\n name\n
The name of the Application Component.
\nType: String
\n\n type\n
The type of Application Component. For more information about the types of Application Component, see Grouping resources in an AppComponent.
\nType: String
\n\n resourceNames\n
The list of included resources that are assigned to the Application Component.
\nType: Array of strings
\n\n additionalInfo\n
Additional configuration parameters for an AWS Resilience Hub application.
\nCurrently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.
\nKey: \"failover-regions\"\n
Value: \"[{\"region\":\"<REGION>\", \"accounts\":[{\"id\":\"<ACCOUNT_ID>\"}]}]\"\n
\n \n excludedResources\n \n
The list of logical resource identifiers to be excluded from the application.
\nType: Array
\nDon't add the resources that you want to include.
\nEach excludedResources array item includes the following fields:
\n \n logicalResourceIds\n \n
The logical identifier of the resource.
\nType: Object
\nYou can configure only one of the following fields:
\n\n logicalStackName\n
\n resourceGroupName\n
\n terraformSourceName\n
Each logicalResourceIds object includes the following fields:
\n identifier\n
The identifier of the resource.
\nType: String
\n\n logicalStackName\n
The name of the CloudFormation stack this resource belongs to.
\nType: String
\n\n resourceGroupName\n
The name of the resource group this resource belongs to.
\nType: String
\n\n terraformSourceName\n
The name of the Terraform S3 state file this resource belongs to.
\nType: String
\nDescribes the status of importing resources to an application version.
", + "smithy.api#documentation": "Describes the status of importing resources to an application version.
\nIf you get a 404 error with\n ResourceImportStatusNotFoundAppMetadataException, you must call\n importResourcesToDraftAppVersion after creating the application and before\n calling describeDraftAppVersionResourcesImportStatus to obtain the\n status.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: \narn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: \narn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
Imports resources from sources such as a CloudFormation stack, resource-groups, or application\n registry app to a draft application version.
", + "smithy.api#documentation": "Imports resources to AWS Resilience Hub application draft version from different input sources. For more information about the input sources supported by AWS Resilience Hub, see Discover\n the structure and describe your Resilience Hub application.
", "smithy.api#http": { "method": "POST", "uri": "/import-resources-to-draft-app-version", @@ -3918,7 +4307,7 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
\n A list of terraform file s3 URLs you need to import.\n
" } + }, + "importStrategy": { + "target": "com.amazonaws.resiliencehub#ResourceImportStrategyType", + "traits": { + "smithy.api#documentation": "The import strategy you would like to set to import resources into AWS Resilience Hub\n application.
" + } } } }, @@ -3942,7 +4337,7 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
Lists the alarm recommendations for a AWS Resilience Hub application.
", + "smithy.api#documentation": "Lists the alarm recommendations for an AWS Resilience Hub application.
", "smithy.api#http": { "method": "POST", "uri": "/list-alarm-recommendations", @@ -4032,7 +4433,7 @@ "assessmentArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
The alarm recommendations for an AWS Resilience Hub application, returned as an object. This\n object includes application component names, descriptions, information about whether a\n recommendation has already been implemented or not, prerequisites, and more.
", + "smithy.api#documentation": "The alarm recommendations for an AWS Resilience Hub application, returned as an object. This\n object includes Application Component names, descriptions, information about whether a\n recommendation has already been implemented or not, prerequisites, and more.
", "smithy.api#required": {} } }, @@ -4114,7 +4515,7 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
Lists the compliances for an AWS Resilience Hub component.
", + "smithy.api#documentation": "Lists the compliances for an AWS Resilience Hub Application Component.
", "smithy.api#http": { "method": "POST", "uri": "/list-app-component-compliances", @@ -4244,7 +4645,7 @@ "assessmentArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
The compliances for an AWS Resilience Hub application component, returned as an object. This\n object contains component names, compliances, costs, resiliency scores, outage scores, and\n more.
", + "smithy.api#documentation": "The compliances for an AWS Resilience Hub Application Component, returned as an object. This\n object contains the names of the Application Components, compliances, costs, resiliency scores, outage scores, and\n more.
", "smithy.api#required": {} } }, @@ -4294,7 +4695,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the recommendations for an AWS Resilience Hub component.
", + "smithy.api#documentation": "Lists the recommendations for an AWS Resilience Hub Application Component.
", "smithy.api#http": { "method": "POST", "uri": "/list-app-component-recommendations", @@ -4313,7 +4714,7 @@ "assessmentArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
The recommendations for an Resilience Hub application component, returned as an object. This\n object contains component names, configuration recommendations, and recommendation\n statuses.
", + "smithy.api#documentation": "The recommendations for an AWS Resilience Hub Application Component, returned as an object. This\n object contains the names of the Application Components, configuration recommendations, and recommendation\n statuses.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.resiliencehub#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.
" + } + } + } + }, + "com.amazonaws.resiliencehub#ListAppInputSources": { + "type": "operation", + "input": { + "target": "com.amazonaws.resiliencehub#ListAppInputSourcesRequest" + }, + "output": { + "target": "com.amazonaws.resiliencehub#ListAppInputSourcesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.resiliencehub#AccessDeniedException" + }, + { + "target": "com.amazonaws.resiliencehub#InternalServerException" + }, + { + "target": "com.amazonaws.resiliencehub#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.resiliencehub#ThrottlingException" + }, + { + "target": "com.amazonaws.resiliencehub#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all the input sources of the AWS Resilience Hub application. For more information about the\n input sources supported by AWS Resilience Hub, see Discover\n the structure and describe your Resilience Hub application.
", + "smithy.api#http": { + "method": "POST", + "uri": "/list-app-input-sources", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.resiliencehub#ListAppInputSourcesRequest": { + "type": "structure", + "members": { + "appArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
The AWS Resilience Hub application version.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.resiliencehub#NextToken", + "traits": { + "smithy.api#documentation": "Null, or the token from a previous call to get the next set of results.
" + } + }, + "maxResults": { + "target": "com.amazonaws.resiliencehub#MaxResults", + "traits": { + "smithy.api#documentation": "Maximum number of input sources to be displayed per AWS Resilience Hub application.
" + } + } + } + }, + "com.amazonaws.resiliencehub#ListAppInputSourcesResponse": { + "type": "structure", + "members": { + "appInputSources": { + "target": "com.amazonaws.resiliencehub#AppInputSourceList", + "traits": { + "smithy.api#documentation": "The list of AWS Resilience Hub application input sources.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.resiliencehub#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.
" + } + } + } + }, + "com.amazonaws.resiliencehub#ListAppVersionAppComponents": { + "type": "operation", + "input": { + "target": "com.amazonaws.resiliencehub#ListAppVersionAppComponentsRequest" + }, + "output": { + "target": "com.amazonaws.resiliencehub#ListAppVersionAppComponentsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.resiliencehub#AccessDeniedException" + }, + { + "target": "com.amazonaws.resiliencehub#ConflictException" + }, + { + "target": "com.amazonaws.resiliencehub#InternalServerException" + }, + { + "target": "com.amazonaws.resiliencehub#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.resiliencehub#ThrottlingException" + }, + { + "target": "com.amazonaws.resiliencehub#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all the Application Components in the AWS Resilience Hub application.
", + "smithy.api#http": { + "method": "POST", + "uri": "/list-app-version-app-components", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.resiliencehub#ListAppVersionAppComponentsRequest": { + "type": "structure", + "members": { + "appArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
The version of the Application Component.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.resiliencehub#NextToken", + "traits": { + "smithy.api#documentation": "Null, or the token from a previous call to get the next set of results.
" + } + }, + "maxResults": { + "target": "com.amazonaws.resiliencehub#MaxResults", + "traits": { + "smithy.api#documentation": "Maximum number of Application Components to be displayed per AWS Resilience Hub application version.
" + } + } + } + }, + "com.amazonaws.resiliencehub#ListAppVersionAppComponentsResponse": { + "type": "structure", + "members": { + "appArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
The AWS Resilience Hub application version.
", "smithy.api#required": {} } }, + "appComponents": { + "target": "com.amazonaws.resiliencehub#AppComponentList", + "traits": { + "smithy.api#documentation": "Defines an Application Component.
" + } + }, "nextToken": { "target": "com.amazonaws.resiliencehub#NextToken", "traits": { @@ -4394,7 +4987,7 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
Lists all the resources in an application version.
", + "smithy.api#documentation": "Lists all the resources in an AWS Resilience Hub application.
", "smithy.api#http": { "method": "POST", "uri": "/list-app-version-resources", @@ -4485,7 +5078,7 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
The identifier for a specific resolution.
", + "smithy.api#documentation": "The ID for a specific resolution.
", "smithy.api#required": {} } }, @@ -4564,7 +5157,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the different versions for the Resilience Hub applications.
", + "smithy.api#documentation": "Lists the different versions for the AWS Resilience Hub applications.
", "smithy.api#http": { "method": "POST", "uri": "/list-app-versions", @@ -4583,7 +5176,7 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
Lists your Resilience Hub applications.
", + "smithy.api#documentation": "Lists your AWS Resilience Hub applications.
\nYou can filter applications using only one filter at a time or without using any filter.\n If you try to filter applications using multiple filters, you will get the following\n error:
\n\n An error occurred (ValidationException) when calling the ListApps operation: Only\n one filter is supported for this operation.\n
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
Summaries for the Resilience Hub application.
", + "smithy.api#documentation": "Summaries for the AWS Resilience Hub application.
", "smithy.api#required": {} } }, @@ -4730,7 +5323,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the recommendation templates for the Resilience Hub applications.
", + "smithy.api#documentation": "Lists the recommendation templates for the AWS Resilience Hub applications.
", "smithy.api#http": { "method": "GET", "uri": "/list-recommendation-templates", @@ -4750,7 +5343,7 @@ "assessmentArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
The recommendation templates for the Resilience Hub applications.
" + "smithy.api#documentation": "The recommendation templates for the AWS Resilience Hub applications.
" } } } @@ -4842,7 +5435,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the resiliency policies for the Resilience Hub applications.
", + "smithy.api#documentation": "Lists the resiliency policies for the AWS Resilience Hub applications.
", "smithy.api#http": { "method": "GET", "uri": "/list-resiliency-policies", @@ -4888,7 +5481,7 @@ "resiliencyPolicies": { "target": "com.amazonaws.resiliencehub#ResiliencyPolicies", "traits": { - "smithy.api#documentation": "The resiliency policies for the Resilience Hub applications.
", + "smithy.api#documentation": "The resiliency policies for the AWS Resilience Hub applications.
", "smithy.api#required": {} } }, @@ -4929,7 +5522,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the standard operating procedure (SOP) recommendations for the Resilience Hub\n applications.
", + "smithy.api#documentation": "Lists the standard operating procedure (SOP) recommendations for the AWS Resilience Hub\n applications.
", "smithy.api#http": { "method": "POST", "uri": "/list-sop-recommendations", @@ -4960,7 +5553,7 @@ "assessmentArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
The standard operating procedure (SOP) recommendations for the Resilience Hub\n applications.
", + "smithy.api#documentation": "The standard operating procedure (SOP) recommendations for the AWS Resilience Hub\n applications.
", "smithy.api#required": {} } } @@ -5010,7 +5603,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the suggested resiliency policies for the Resilience Hub applications.
", + "smithy.api#documentation": "Lists the suggested resiliency policies for the AWS Resilience Hub applications.
", "smithy.api#http": { "method": "GET", "uri": "/list-suggested-resiliency-policies", @@ -5049,7 +5642,7 @@ "resiliencyPolicies": { "target": "com.amazonaws.resiliencehub#ResiliencyPolicies", "traits": { - "smithy.api#documentation": "The suggested resiliency policies for the Resilience Hub applications.
", + "smithy.api#documentation": "The suggested resiliency policies for the AWS Resilience Hub applications.
", "smithy.api#required": {} } }, @@ -5087,7 +5680,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the tags for your resources in your Resilience Hub applications.
", + "smithy.api#documentation": "Lists the tags for your resources in your AWS Resilience Hub applications.
", "smithy.api#http": { "method": "GET", "uri": "/tags/{resourceArn}", @@ -5102,7 +5695,7 @@ "resourceArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for a specific resource in your Resilience Hub\n application.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) for a specific resource in your AWS Resilience Hub\n application.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5149,7 +5742,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the test recommendations for the Resilience Hub application.
", + "smithy.api#documentation": "Lists the test recommendations for the AWS Resilience Hub application.
", "smithy.api#http": { "method": "POST", "uri": "/list-test-recommendations", @@ -5180,7 +5773,7 @@ "assessmentArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
The test recommendations for the Resilience Hub application.
", + "smithy.api#documentation": "The test recommendations for the AWS Resilience Hub application.
", "smithy.api#required": {} } } @@ -5233,7 +5826,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the resources that are not currently supported in AWS Resilience Hub. An unsupported\n resource is a resource that exists in the object that was used to create an app, but is not\n supported by Resilience Hub.
", + "smithy.api#documentation": "Lists the resources that are not currently supported in AWS Resilience Hub. An unsupported\n resource is a resource that exists in the object that was used to create an app, but is not\n supported by AWS Resilience Hub.
", "smithy.api#http": { "method": "POST", "uri": "/list-unsupported-app-version-resources", @@ -5252,7 +5845,7 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
The application components that belong to this resource.
" } + }, + "additionalInfo": { + "target": "com.amazonaws.resiliencehub#AdditionalInfoMap", + "traits": { + "smithy.api#documentation": "Additional configuration parameters for an AWS Resilience Hub application.
\nCurrently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.
\nKey: \"failover-regions\"\n
Value: \"[{\"region\":\"<REGION>\", \"accounts\":[{\"id\":\"<ACCOUNT_ID>\"}]}]\"\n
Indicates if a resource is included or excluded from the assessment.
" + } } }, "traits": { - "smithy.api#documentation": "Defines a physical resource. A physical resource is a resource that exists in your\n account. It can be identified using an Amazon Resource Name (ARN) or a Resilience Hub-native\n identifier.
" + "smithy.api#documentation": "Defines a physical resource. A physical resource is a resource that exists in your\n account. It can be identified using an Amazon Resource Name (ARN) or an AWS Resilience Hub-native\n identifier.
" } }, "com.amazonaws.resiliencehub#PhysicalResourceId": { @@ -5425,7 +6030,7 @@ "type": { "target": "com.amazonaws.resiliencehub#PhysicalIdentifierType", "traits": { - "smithy.api#documentation": "Specifies the type of physical resource identifier.
\nThe resource identifier is an Amazon Resource Name (ARN) .
\nThe resource identifier is a Resilience Hub-native identifier.
\nSpecifies the type of physical resource identifier.
\nThe resource identifier is an Amazon Resource Name (ARN) .
\nThe resource identifier is an AWS Resilience Hub-native identifier.
\nPublishes a new version of a specific Resilience Hub application.
", + "smithy.api#documentation": "Publishes a new version of a specific AWS Resilience Hub application.
", "smithy.api#http": { "method": "POST", "uri": "/publish-app-version", @@ -5495,7 +6100,7 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
Adds or updates the app template for a draft version of a Resilience Hub app.
", + "smithy.api#documentation": "Adds or updates the app template for an AWS Resilience Hub application draft version.
", "smithy.api#http": { "method": "POST", "uri": "/put-draft-app-version-template", @@ -5562,14 +6167,14 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
A JSON string that contains the body of the app template.
", + "smithy.api#documentation": "A JSON string that provides information about your application structure. To learn more\n about the appTemplateBody template, see the sample template provided in the\n Examples section.
The appTemplateBody JSON string has the following structure:
\n \n resources\n \n
The list of logical resources that needs to be included in the application.
\nType: Array
\nDon't add the resources that you want to exclude.
\nEach resources array item includes the following fields:
\n \n logicalResourceId\n \n
The logical identifier of the resource.
\nType: Object
\nEach logicalResourceId object includes the following fields:
\n identifier\n
The identifier of the resource.
\nType: String
\n\n logicalStackName\n
The name of the CloudFormation stack this resource belongs to.
\nType: String
\n\n resourceGroupName\n
The name of the resource group this resource belongs to.
\nType: String
\n\n terraformSourceName\n
The name of the Terraform S3 state file this resource belongs to.
\nType: String
\n\n \n type\n \n
The type of resource.
\nType: string
\n\n \n name\n \n
The name of the resource.
\nType: String
\n\n \n appComponents\n \n
The list of Application Components that this resource belongs to. If an Application Component is not part of the AWS Resilience Hub application, it will be added.
\nType: Array
\nEach appComponents array item includes the following fields:
\n name\n
The name of the Application Component.
\nType: String
\n\n type\n
The type of Application Component. For more information about the types of Application Component, see Grouping resources in an AppComponent.
\nType: String
\n\n resourceNames\n
The list of included resources that are assigned to the Application Component.
\nType: Array of strings
\n\n additionalInfo\n
Additional configuration parameters for an AWS Resilience Hub application.
\nCurrently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.
\nKey: \"failover-regions\"\n
Value: \"[{\"region\":\"<REGION>\", \"accounts\":[{\"id\":\"<ACCOUNT_ID>\"}]}]\"\n
\n \n excludedResources\n \n
The list of logical resource identifiers to be excluded from the application.
\nType: Array
\nDon't add the resources that you want to include.
\nEach excludedResources array item includes the following fields:
\n \n logicalResourceIds\n \n
The logical identifier of the resource.
\nType: Object
\nYou can configure only one of the following fields:
\n\n logicalStackName\n
\n resourceGroupName\n
\n terraformSourceName\n
Each logicalResourceIds object includes the following fields:
\n identifier\n
The identifier of the resource.
\nType: String
\n\n logicalStackName\n
The name of the CloudFormation stack this resource belongs to.
\nType: String
\n\n resourceGroupName\n
The name of the resource group this resource belongs to.
\nType: String
\n\n terraformSourceName\n
The name of the Terraform S3 state file this resource belongs to.
\nType: String
\nThe Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
The names of the resources to remove from the resource mappings.
" + "smithy.api#documentation": "The names of the resources you want to remove from the resource mappings.
" } }, "logicalStackNames": { "target": "com.amazonaws.resiliencehub#String255List", "traits": { - "smithy.api#documentation": "The names of the CloudFormation stacks to remove from the resource mappings.
" + "smithy.api#documentation": "The names of the CloudFormation stacks you want to remove from the resource mappings.
" } }, "appRegistryAppNames": { "target": "com.amazonaws.resiliencehub#EntityNameList", "traits": { - "smithy.api#documentation": "The names of the registered applications to remove from the resource mappings.
" + "smithy.api#documentation": "The names of the registered applications you want to remove from the resource mappings.
" } }, "resourceGroupNames": { "target": "com.amazonaws.resiliencehub#EntityNameList", "traits": { - "smithy.api#documentation": "The names of the resource groups to remove from the resource mappings.
" + "smithy.api#documentation": "The names of the resource groups you want to remove from the resource mappings.
" } }, "terraformSourceNames": { "target": "com.amazonaws.resiliencehub#String255List", "traits": { - "smithy.api#documentation": "\n \n
" + "smithy.api#documentation": "The names of the Terraform sources you want to remove from the resource mappings.
" } } } @@ -5935,7 +6540,7 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: \narn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: \narn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
The specified resource could not be found.
", + "smithy.api#documentation": "This exception occurs when the specified resource could not be found.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -6453,7 +7073,7 @@ } }, "traits": { - "smithy.api#documentation": "You have exceeded your service quota. To perform the requested action, remove some of the\n relevant resources, or use Service Quotas to request a service quota increase.
", + "smithy.api#documentation": "This exception occurs when you have exceeded your service quota. To perform the requested action, remove some of the\n relevant resources, or use Service Quotas to request a service quota increase.
", "smithy.api#error": "client", "smithy.api#httpError": 402 } @@ -6471,7 +7091,7 @@ "appComponentName": { "target": "com.amazonaws.resiliencehub#EntityId", "traits": { - "smithy.api#documentation": "The application component name.
" + "smithy.api#documentation": "The name of the Application Component.
" } }, "description": { @@ -6589,7 +7209,7 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
The name of the application component.
" + "smithy.api#documentation": "The name of the Application Component.
" } }, "name": { @@ -6944,7 +7588,7 @@ } }, "traits": { - "smithy.api#documentation": "The limit on the number of requests per second was exceeded.
", + "smithy.api#documentation": "This exception occurs when you have exceeded the limit on the number of requests per second.
", "smithy.api#error": "client", "smithy.api#httpError": 429 } @@ -6978,7 +7622,7 @@ } }, "traits": { - "smithy.api#documentation": "Defines a resource that is not supported by Resilience Hub.
" + "smithy.api#documentation": "Defines a resource that is not supported by AWS Resilience Hub.
" } }, "com.amazonaws.resiliencehub#UnsupportedResourceList": { @@ -7035,7 +7679,7 @@ "tagKeys": { "target": "com.amazonaws.resiliencehub#TagKeyList", "traits": { - "smithy.api#documentation": "The keys of the tags to remove.
", + "smithy.api#documentation": "The keys of the tags you want to remove.
", "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } @@ -7089,7 +7733,7 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: \narn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: \narn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
Updates the AWS Resilience Hub application version.
\nThis API updates the AWS Resilience Hub application draft version. To use this information\n for running resiliency assessments, you must publish the AWS Resilience Hub application using the\n PublishAppVersion API.
Updates an existing Application Component in the AWS Resilience Hub application.
\nThis API updates the AWS Resilience Hub application draft version. To use this Application Component for running assessments, you must publish the AWS Resilience Hub application using the PublishAppVersion API.
The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
The identifier of the Application Component.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.resiliencehub#String255", + "traits": { + "smithy.api#documentation": "The name of the Application Component.
" + } + }, + "type": { + "target": "com.amazonaws.resiliencehub#String255", + "traits": { + "smithy.api#documentation": "The type of Application Component. For more information about the types of Application Component, see Grouping resources in an AppComponent.
" + } + }, + "additionalInfo": { + "target": "com.amazonaws.resiliencehub#AdditionalInfoMap", + "traits": { + "smithy.api#documentation": "Currently, there is no supported additional information for Application Components.
" + } + } + } + }, + "com.amazonaws.resiliencehub#UpdateAppVersionAppComponentResponse": { + "type": "structure", + "members": { + "appArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
The AWS Resilience Hub application version.
", + "smithy.api#required": {} + } + }, + "appComponent": { + "target": "com.amazonaws.resiliencehub#AppComponent" + } + } + }, + "com.amazonaws.resiliencehub#UpdateAppVersionRequest": { + "type": "structure", + "members": { + "appArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
Additional configuration parameters for an AWS Resilience Hub application.
\nCurrently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.
\nKey: \"failover-regions\"\n
Value: \"[{\"region\":\"<REGION>\", \"accounts\":[{\"id\":\"<ACCOUNT_ID>\"}]}]\"\n
Updates the resource details in the AWS Resilience Hub application.
\nThis action has no effect outside AWS Resilience Hub.
\nThis API updates the AWS Resilience Hub application draft version. To use this resource for running resiliency assessments, you must publish the AWS Resilience Hub application using the PublishAppVersion API.
To update application version with new physicalResourceID, you must call\n ResolveAppVersionResources API.
The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
The name of the resource.
" + } + }, + "logicalResourceId": { + "target": "com.amazonaws.resiliencehub#LogicalResourceId", + "traits": { + "smithy.api#documentation": "The logical identifier of the resource.
" + } + }, + "physicalResourceId": { + "target": "com.amazonaws.resiliencehub#String2048", + "traits": { + "smithy.api#documentation": "The physical identifier of the resource.
" + } + }, + "awsRegion": { + "target": "com.amazonaws.resiliencehub#AwsRegion", + "traits": { + "smithy.api#documentation": "The Amazon Web Services region that owns the physical resource.
" + } + }, + "awsAccountId": { + "target": "com.amazonaws.resiliencehub#CustomerId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account that owns the physical resource.
" + } + }, + "resourceType": { + "target": "com.amazonaws.resiliencehub#String255", + "traits": { + "smithy.api#documentation": "The type of resource.
" + } + }, + "appComponents": { + "target": "com.amazonaws.resiliencehub#AppComponentNameList", + "traits": { + "smithy.api#documentation": "The list of Application Components that this resource belongs to. If an Application Component is not part of the AWS Resilience Hub application, it will be added.
" + } + }, + "additionalInfo": { + "target": "com.amazonaws.resiliencehub#AdditionalInfoMap", + "traits": { + "smithy.api#documentation": "Currently, there is no supported additional information for resources.
" + } + }, + "excluded": { + "target": "com.amazonaws.resiliencehub#BooleanOptional", + "traits": { + "smithy.api#documentation": "Indicates if a resource is excluded from an AWS Resilience Hub application.
\nYou can exclude only imported resources from an AWS Resilience Hub application.
\nThe Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
The AWS Resilience Hub application version.
", + "smithy.api#required": {} + } + }, + "physicalResource": { + "target": "com.amazonaws.resiliencehub#PhysicalResource", + "traits": { + "smithy.api#documentation": "Defines a physical resource. A physical resource is a resource that exists in your account. It can be identified using an Amazon Resource Name (ARN) or a Resilience Hub-native identifier.
" + } + } + } + }, + "com.amazonaws.resiliencehub#UpdateAppVersionResponse": { + "type": "structure", + "members": { + "appArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
The AWS Resilience Hub application version.
", + "smithy.api#required": {} + } + }, + "additionalInfo": { + "target": "com.amazonaws.resiliencehub#AdditionalInfoMap", + "traits": { + "smithy.api#documentation": "Additional configuration parameters for an AWS Resilience Hub application.
\nCurrently, this parameter supports only failover region and account.
\nThe Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: \narn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: \narn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.
Indicates that a request was not valid.
", + "smithy.api#documentation": "This exception occurs when a request is not valid.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } diff --git a/codegen/sdk-codegen/aws-models/securityhub.json b/codegen/sdk-codegen/aws-models/securityhub.json index 7499f843956..dd989fb5274 100644 --- a/codegen/sdk-codegen/aws-models/securityhub.json +++ b/codegen/sdk-codegen/aws-models/securityhub.json @@ -567,13 +567,13 @@ "FirstSeen": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "An ISO8601-formatted timestamp that indicates when the API call was first\n observed.
" + "smithy.api#documentation": "An ISO8601-formatted timestamp that indicates when the API call was first\n observed.
\nA correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date and time should be separated by T. For more information, see RFC 3339 section 5.6, Internet Date/Time Format.
An ISO8601-formatted timestamp that indicates when the API call was most recently\n observed.
" + "smithy.api#documentation": "An ISO8601-formatted timestamp that indicates when the API call was most recently\n observed.
\nA correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date and time should be separated by T. For more information, see RFC 3339 section 5.6, Internet Date/Time Format.
Indicates when the API was created.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the API was created.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the stage was created.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the stage was created.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the stage was most recently updated.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the stage was most recently updated.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the API was created.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the API was created.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the stage was created.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the stage was created.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the stage was most recently updated.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the stage was most recently updated.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the auto scaling group was created.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the auto scaling group was created.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
The creation date and time for the launch configuration.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
The creation date and time for the launch configuration.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the certificate was requested.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the certificate was requested.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the certificate was imported. Provided if the certificate type is\n IMPORTED.
Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the certificate was imported. Provided if the certificate type is\n IMPORTED.
Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the certificate was issued. Provided if the certificate type is\n AMAZON_ISSUED.
Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the certificate was issued. Provided if the certificate type is\n AMAZON_ISSUED.
Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
The time after which the certificate becomes invalid.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
The time after which the certificate becomes invalid.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
The time before which the certificate is not valid.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
The time before which the certificate is not valid.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the renewal summary was last updated.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the renewal summary was last updated.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when that the distribution was last modified.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when that the distribution was last modified.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
If the billing mode is PAY_PER_REQUEST, indicates when the billing mode was\n set to that value.
Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
If the billing mode is PAY_PER_REQUEST, indicates when the billing mode was\n set to that value.
Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the table was created.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the table was created.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the provisioned throughput was last decreased.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the provisioned throughput was last decreased.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the provisioned throughput was last increased.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the provisioned throughput was last increased.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
Indicates the point in time that the table was restored to.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
Indicates the point in time that the table was restored to.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
If the key is inaccessible, the date and time when DynamoDB detected that the key was\n inaccessible.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
If the key is inaccessible, the date and time when DynamoDB detected that the key was\n inaccessible.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the instance was launched.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the instance was launched.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the attachment initiated.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the attachment initiated.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the volume was created.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the volume was created.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
The date and time of the last change in status.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
The date and time of the last change in status.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
The date and time when the image was pushed to the repository.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
The date and time when the image was pushed to the repository.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the load balancer was created.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the load balancer was created.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the load balancer was created.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the load balancer was created.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the IAM access key was created.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the IAM access key was created.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the session was created.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the session was created.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the IAM group was created.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the IAM group was created.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the instance profile was created.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the instance profile was created.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the role was created.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the role was created.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
When the policy was created.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
When the policy was created.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
When the policy was most recently updated.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
When the policy was most recently updated.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the version was created.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the version was created.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the role was created.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the role was created.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the user was created.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the user was created.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the KMS key was created.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the KMS key was created.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the function was last updated.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the function was last updated.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the version was created.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the version was created.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the DB cluster was created, in Universal Coordinated Time (UTC).
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the DB cluster was created, in Universal Coordinated Time (UTC).
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the snapshot was taken.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the snapshot was taken.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the DB cluster was created, in Universal Coordinated Time (UTC).
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the DB cluster was created, in Universal Coordinated Time (UTC).
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the DB instance was created.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the DB instance was created.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
Specifies the latest time to which a database can be restored with point-in-time\n restore.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
Specifies the latest time to which a database can be restored with point-in-time\n restore.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
The datetime when the event notification subscription was created.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
The datetime when the event notification subscription was created.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
The end of the time window for which maintenance was deferred.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
The end of the time window for which maintenance was deferred.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
The start of the time window for which maintenance was deferred.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
The start of the time window for which maintenance was deferred.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the cluster was created.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the cluster was created.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the next snapshot is expected to be taken. The cluster must have a valid\n snapshot schedule and have backups enabled.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the next snapshot is expected to be taken. The cluster must have a valid\n snapshot schedule and have backups enabled.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
Indicates the start of the next maintenance window.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
Indicates the start of the next maintenance window.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
The last time when logs failed to be delivered.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
The last time when logs failed to be delivered.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
The last time that logs were delivered successfully.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
The last time that logs were delivered successfully.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
The date when objects are moved or deleted.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
The date when objects are moved or deleted.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
A date on which to transition objects to the specified storage class. If you provide Date, you cannot provide Days.
Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
A date on which to transition objects to the specified storage class. If you provide Date, you cannot provide Days.
Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the S3 bucket was created.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the S3 bucket was created.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the object was last modified.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the object was last modified.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the security-findings provider first observed the potential security\n issue that a finding captured.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the security-findings provider first observed the potential security\n issue that a finding captured.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the security-findings provider most recently observed the potential\n security issue that a finding captured.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the security-findings provider most recently observed the potential\n security issue that a finding captured.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the security-findings provider created the potential security issue that\n a finding captured.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the security-findings provider created the potential security issue that\n a finding captured.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the security-findings provider last updated the finding record.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the security-findings provider last updated the finding record.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
An ISO8601-formatted timestamp that indicates when the security-findings provider first\n observed the potential security issue that a finding captured.
" + "smithy.api#documentation": "An ISO8601-formatted timestamp that indicates when the security-findings provider first\n observed the potential security issue that a finding captured.
\nA correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date and time should be separated by T. For more information, see RFC 3339 section 5.6, Internet Date/Time Format.
An ISO8601-formatted timestamp that indicates when the security-findings provider most\n recently observed the potential security issue that a finding captured.
" + "smithy.api#documentation": "An ISO8601-formatted timestamp that indicates when the security-findings provider most\n recently observed the potential security issue that a finding captured.
\nA correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date and time should be separated by T. For more information, see RFC 3339 section 5.6, Internet Date/Time Format.
An ISO8601-formatted timestamp that indicates when the security-findings provider\n captured the potential security issue that a finding captured.
" + "smithy.api#documentation": "An ISO8601-formatted timestamp that indicates when the security-findings provider\n captured the potential security issue that a finding captured.
\nA correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date and time should be separated by T. For more information, see RFC 3339 section 5.6, Internet Date/Time Format.
An ISO8601-formatted timestamp that indicates when the security-findings provider last\n updated the finding record.
" + "smithy.api#documentation": "An ISO8601-formatted timestamp that indicates when the security-findings provider last\n updated the finding record.
\nA correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date and time should be separated by T. For more information, see RFC 3339 section 5.6, Internet Date/Time Format.
The date/time that the process was launched.
" + "smithy.api#documentation": "A timestamp that identifies when the process was launched.
\nA correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date and time should be separated by T. For more information, see RFC 3339 section 5.6, Internet Date/Time Format.
The date/time that the process was terminated.
" + "smithy.api#documentation": "A timestamp that identifies when the process was terminated.
\nA correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date and time should be separated by T. For more information, see RFC 3339 section 5.6, Internet Date/Time Format.
The date/time of the last observation of a threat intelligence indicator.
" + "smithy.api#documentation": "A timestamp that identifies the last observation of a threat intelligence indicator.
" } }, "ThreatIntelIndicatorSource": { @@ -16376,7 +16376,7 @@ "ResourceContainerLaunchedAt": { "target": "com.amazonaws.securityhub#DateFilterList", "traits": { - "smithy.api#documentation": "The date/time that the container was started.
" + "smithy.api#documentation": "A timestamp that identifies when the container was started.
\nA correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date and time should be separated by T. For more information, see RFC 3339 section 5.6, Internet Date/Time Format.
Indicates when the container started.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the container started.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
A start date for the date filter.
" + "smithy.api#documentation": "A timestamp that provides the start date for the date filter.
\nA correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date and time should be separated by T. \n For more information, see RFC 3339 section 5.6, Internet Date/Time Format.
An end date for the date filter.
" + "smithy.api#documentation": "A timestamp that provides the end date for the date filter.
\nA correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date and time should be separated by T. \n For more information, see RFC 3339 section 5.6, Internet Date/Time Format.
Enables Security Hub for your account in the current Region or the Region you specify in the\n request.
\nWhen you enable Security Hub, you grant to Security Hub the permissions necessary to gather findings\n from other services that are integrated with Security Hub.
\nWhen you use the EnableSecurityHub operation to enable Security Hub, you also\n automatically enable the following standards.
CIS Amazon Web Services Foundations
\nAmazon Web Services Foundational Security Best Practices
\nYou do not enable the Payment Card Industry Data Security Standard (PCI DSS) standard.
\nTo not enable the automatically enabled standards, set\n EnableDefaultStandards to false.
After you enable Security Hub, to enable a standard, use the BatchEnableStandards operation. To disable a standard, use the\n BatchDisableStandards operation.
To learn more, see the setup information in the Security Hub User Guide.
", + "smithy.api#documentation": "Enables Security Hub for your account in the current Region or the Region you specify in the\n request.
\nWhen you enable Security Hub, you grant to Security Hub the permissions necessary to gather findings\n from other services that are integrated with Security Hub.
\nWhen you use the EnableSecurityHub operation to enable Security Hub, you also\n automatically enable the following standards:
Center for Internet Security (CIS) Amazon Web Services Foundations Benchmark v1.2.0
\nAmazon Web Services Foundational Security Best Practices
\nOther standards are not automatically enabled.
\nTo opt out of automatically enabled standards, set\n EnableDefaultStandards to false.
After you enable Security Hub, to enable a standard, use the BatchEnableStandards operation. To disable a standard, use the\n BatchDisableStandards operation.
To learn more, see the setup information in the Security Hub User Guide.
", "smithy.api#http": { "method": "POST", "uri": "/accounts", @@ -22908,7 +22908,7 @@ "UpdatedAt": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "The timestamp of when the note was updated.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
The timestamp of when the note was updated.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the operation started.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the operation started.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the operation completed.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the operation completed.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the process was launched.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the process was launched.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the process was terminated.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the process was terminated.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the most recent instance of a threat intelligence indicator was\n observed.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the most recent instance of a threat intelligence indicator was\n observed.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the vulnerability advisory was created.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the vulnerability advisory was created.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the vulnerability advisory was last updated.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the vulnerability advisory was last updated.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
Insufficient permissions to make request.
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.tnb#CancelSolNetworkOperation": { + "type": "operation", + "input": { + "target": "com.amazonaws.tnb#CancelSolNetworkOperationInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.tnb#AccessDeniedException" + }, + { + "target": "com.amazonaws.tnb#InternalServerException" + }, + { + "target": "com.amazonaws.tnb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.tnb#ThrottlingException" + }, + { + "target": "com.amazonaws.tnb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Cancels a network operation.
\nA network operation is any operation that is done to your network, such as network instance instantiation or termination.
", + "smithy.api#examples": [ + { + "title": "Cancel a in-progress Sol Network Operation.", + "input": { + "nsLcmOpOccId": "no-0d5b823eb5c2a9241" + } + } + ], + "smithy.api#http": { + "method": "POST", + "uri": "/sol/nslcm/v1/ns_lcm_op_occs/{nsLcmOpOccId}/cancel", + "code": 202 + } + } + }, + "com.amazonaws.tnb#CancelSolNetworkOperationInput": { + "type": "structure", + "members": { + "nsLcmOpOccId": { + "target": "com.amazonaws.tnb#NsLcmOpOccId", + "traits": { + "smithy.api#documentation": "The ID of a network operation occurrence.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.tnb#CreateSolFunctionPackage": { + "type": "operation", + "input": { + "target": "com.amazonaws.tnb#CreateSolFunctionPackageInput" + }, + "output": { + "target": "com.amazonaws.tnb#CreateSolFunctionPackageOutput" + }, + "errors": [ + { + "target": "com.amazonaws.tnb#AccessDeniedException" + }, + { + "target": "com.amazonaws.tnb#InternalServerException" + }, + { + "target": "com.amazonaws.tnb#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.tnb#ThrottlingException" + }, + { + "target": "com.amazonaws.tnb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a function package.
\nA function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network. For more information, see Function packages in the Amazon Web Services Telco Network Builder User Guide. \n
\nCreating a function package is the first step for creating a network in AWS TNB. This request creates an empty container with an ID. The next step is to upload the actual CSAR zip file into that empty container. To upload function package content, see PutSolFunctionPackageContent.
", + "smithy.api#examples": [ + { + "title": "Create a Sol function package", + "input": { + "tags": { + "Name": "Resource" + } + }, + "output": { + "onboardingState": "CREATED", + "operationalState": "DISABLED", + "usageState": "NOT_IN_USE", + "id": "fp-07aa863e53460a2a6", + "arn": "arn:aws:tnb:us-west-2:123456789000:function-package/fp-07aa863e53460a2a6", + "tags": { + "Name": "Resource" + } + } + } + ], + "smithy.api#http": { + "method": "POST", + "uri": "/sol/vnfpkgm/v1/vnf_packages", + "code": 201 + } + } + }, + "com.amazonaws.tnb#CreateSolFunctionPackageInput": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.tnb#TagMap", + "traits": { + "smithy.api#documentation": "A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.tnb#CreateSolFunctionPackageOutput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.tnb#VnfPkgId", + "traits": { + "smithy.api#documentation": "ID of the function package.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.tnb#VnfPkgArn", + "traits": { + "smithy.api#documentation": "Function package ARN.
", + "smithy.api#required": {} + } + }, + "onboardingState": { + "target": "com.amazonaws.tnb#OnboardingState", + "traits": { + "smithy.api#documentation": "Onboarding state of the function package.
", + "smithy.api#required": {} + } + }, + "operationalState": { + "target": "com.amazonaws.tnb#OperationalState", + "traits": { + "smithy.api#documentation": "Operational state of the function package.
", + "smithy.api#required": {} + } + }, + "usageState": { + "target": "com.amazonaws.tnb#UsageState", + "traits": { + "smithy.api#documentation": "Usage state of the function package.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.tnb#TagMap", + "traits": { + "smithy.api#documentation": "A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.tnb#CreateSolNetworkInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.tnb#CreateSolNetworkInstanceInput" + }, + "output": { + "target": "com.amazonaws.tnb#CreateSolNetworkInstanceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.tnb#AccessDeniedException" + }, + { + "target": "com.amazonaws.tnb#InternalServerException" + }, + { + "target": "com.amazonaws.tnb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.tnb#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.tnb#ThrottlingException" + }, + { + "target": "com.amazonaws.tnb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a network instance.
\nA network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed. Creating a network instance is the third step after creating a network package. For more information about network instances, Network instances in the Amazon Web Services Telco Network Builder User Guide.
\nOnce you create a network instance, you can instantiate it. To instantiate a network, see InstantiateSolNetworkInstance.
", + "smithy.api#examples": [ + { + "title": "Create a Sol Network Instance", + "input": { + "nsdInfoId": "np-0d5b823eb5c2a9241", + "nsName": "CITY Instance", + "nsDescription": "Test network for CITY", + "tags": { + "Name": "Resource" + } + }, + "output": { + "id": "ni-07aa863e53460a2a6", + "nsdInfoId": "np-0d5b823eb5c2a9241", + "arn": "arn:aws:tnb:us-west-2:123456789000:network-instance/ni-07aa863e53460a2a6", + "nsInstanceName": "CITY Instance", + "tags": { + "Name": "Resource" + } + } + } + ], + "smithy.api#http": { + "method": "POST", + "uri": "/sol/nslcm/v1/ns_instances", + "code": 201 + } + } + }, + "com.amazonaws.tnb#CreateSolNetworkInstanceInput": { + "type": "structure", + "members": { + "nsdInfoId": { + "target": "com.amazonaws.tnb#NsdInfoId", + "traits": { + "smithy.api#documentation": "ID for network service descriptor.
", + "smithy.api#required": {} + } + }, + "nsName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Network instance name.
", + "smithy.api#length": { + "min": 1, + "max": 80 + }, + "smithy.api#required": {} + } + }, + "nsDescription": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Network instance description.
", + "smithy.api#length": { + "min": 1, + "max": 124 + } + } + }, + "tags": { + "target": "com.amazonaws.tnb#TagMap", + "traits": { + "smithy.api#documentation": "A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.tnb#CreateSolNetworkInstanceOutput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.tnb#NsInstanceId", + "traits": { + "smithy.api#documentation": "Network instance ID.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.tnb#NsInstanceArn", + "traits": { + "smithy.api#documentation": "Network instance ARN.
", + "smithy.api#required": {} + } + }, + "nsdInfoId": { + "target": "com.amazonaws.tnb#NsdInfoId", + "traits": { + "smithy.api#documentation": "Network service descriptor ID.
", + "smithy.api#required": {} + } + }, + "nsInstanceName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Network instance name.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.tnb#TagMap", + "traits": { + "smithy.api#documentation": "A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.tnb#CreateSolNetworkPackage": { + "type": "operation", + "input": { + "target": "com.amazonaws.tnb#CreateSolNetworkPackageInput" + }, + "output": { + "target": "com.amazonaws.tnb#CreateSolNetworkPackageOutput" + }, + "errors": [ + { + "target": "com.amazonaws.tnb#AccessDeniedException" + }, + { + "target": "com.amazonaws.tnb#InternalServerException" + }, + { + "target": "com.amazonaws.tnb#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.tnb#ThrottlingException" + }, + { + "target": "com.amazonaws.tnb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a network package.
\nA network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on. For more information, see Network instances in the Amazon Web Services Telco Network Builder User Guide. \n
\nA network package consists of a network service descriptor (NSD) file (required) and any additional files (optional), such as scripts specific to your needs. For example, if you have multiple function packages in your network package, you can use the NSD to define which network functions should run in certain VPCs, subnets, or EKS clusters.
\nThis request creates an empty network package container with an ID. Once you create a network package, you can upload the network package content using PutSolNetworkPackageContent.
", + "smithy.api#examples": [ + { + "title": "Create a Sol network package", + "input": { + "tags": { + "Name": "Resource" + } + }, + "output": { + "id": "np-0d5b823eb5c2a9241", + "arn": "arn:aws:tnb:us-west-2:123456789000:network-package/np-0d5b823eb5c2a9241", + "nsdOnboardingState": "CREATED", + "nsdOperationalState": "DISABLED", + "nsdUsageState": "NOT_IN_USE", + "tags": { + "Name": "Resource" + } + } + } + ], + "smithy.api#http": { + "method": "POST", + "uri": "/sol/nsd/v1/ns_descriptors", + "code": 201 + } + } + }, + "com.amazonaws.tnb#CreateSolNetworkPackageInput": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.tnb#TagMap", + "traits": { + "smithy.api#documentation": "A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.tnb#CreateSolNetworkPackageOutput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.tnb#NsdInfoId", + "traits": { + "smithy.api#documentation": "ID of the network package.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.tnb#NsdInfoArn", + "traits": { + "smithy.api#documentation": "Network package ARN.
", + "smithy.api#required": {} + } + }, + "nsdOnboardingState": { + "target": "com.amazonaws.tnb#NsdOnboardingState", + "traits": { + "smithy.api#documentation": "Onboarding state of the network service descriptor in the network package.
", + "smithy.api#required": {} + } + }, + "nsdOperationalState": { + "target": "com.amazonaws.tnb#NsdOperationalState", + "traits": { + "smithy.api#documentation": "Operational state of the network service descriptor in the network package.
", + "smithy.api#required": {} + } + }, + "nsdUsageState": { + "target": "com.amazonaws.tnb#NsdUsageState", + "traits": { + "smithy.api#documentation": "Usage state of the network service descriptor in the network package.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.tnb#TagMap", + "traits": { + "smithy.api#documentation": "A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.tnb#DeleteSolFunctionPackage": { + "type": "operation", + "input": { + "target": "com.amazonaws.tnb#DeleteSolFunctionPackageInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.tnb#AccessDeniedException" + }, + { + "target": "com.amazonaws.tnb#InternalServerException" + }, + { + "target": "com.amazonaws.tnb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.tnb#ThrottlingException" + }, + { + "target": "com.amazonaws.tnb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a function package.
\nA function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.
\nTo delete a function package, the package must be in a disabled state. To disable a function package, see UpdateSolFunctionPackage.\n
", + "smithy.api#examples": [ + { + "title": "Delete a function package", + "input": { + "vnfPkgId": "fp-07aa863e53460a2a6" + } + } + ], + "smithy.api#http": { + "method": "DELETE", + "uri": "/sol/vnfpkgm/v1/vnf_packages/{vnfPkgId}", + "code": 204 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.tnb#DeleteSolFunctionPackageInput": { + "type": "structure", + "members": { + "vnfPkgId": { + "target": "com.amazonaws.tnb#VnfPkgId", + "traits": { + "smithy.api#documentation": "ID of the function package.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.tnb#DeleteSolNetworkInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.tnb#DeleteSolNetworkInstanceInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.tnb#AccessDeniedException" + }, + { + "target": "com.amazonaws.tnb#InternalServerException" + }, + { + "target": "com.amazonaws.tnb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.tnb#ThrottlingException" + }, + { + "target": "com.amazonaws.tnb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a network instance.
\nA network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.
\nTo delete a network instance, the instance must be in a stopped or terminated state. To terminate a network instance, see TerminateSolNetworkInstance.
", + "smithy.api#examples": [ + { + "title": "Delete a Sol Network Instance.", + "input": { + "nsInstanceId": "ni-07aa863e53460a2a6" + } + } + ], + "smithy.api#http": { + "method": "DELETE", + "uri": "/sol/nslcm/v1/ns_instances/{nsInstanceId}", + "code": 204 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.tnb#DeleteSolNetworkInstanceInput": { + "type": "structure", + "members": { + "nsInstanceId": { + "target": "com.amazonaws.tnb#NsInstanceId", + "traits": { + "smithy.api#documentation": "Network instance ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.tnb#DeleteSolNetworkPackage": { + "type": "operation", + "input": { + "target": "com.amazonaws.tnb#DeleteSolNetworkPackageInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.tnb#AccessDeniedException" + }, + { + "target": "com.amazonaws.tnb#InternalServerException" + }, + { + "target": "com.amazonaws.tnb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.tnb#ThrottlingException" + }, + { + "target": "com.amazonaws.tnb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes network package.
\nA network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.
\nTo delete a network package, the package must be in a disable state. To disable a network package, see UpdateSolNetworkPackage.
", + "smithy.api#examples": [ + { + "title": "Delete a Sol network package", + "input": { + "nsdInfoId": "np-0d5b823eb5c2a9241" + } + } + ], + "smithy.api#http": { + "method": "DELETE", + "uri": "/sol/nsd/v1/ns_descriptors/{nsdInfoId}", + "code": 204 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.tnb#DeleteSolNetworkPackageInput": { + "type": "structure", + "members": { + "nsdInfoId": { + "target": "com.amazonaws.tnb#NsdInfoId", + "traits": { + "smithy.api#documentation": "ID of the network service descriptor in the network package.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.tnb#DescriptorContentType": { + "type": "enum", + "members": { + "TEXT_PLAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "text/plain" + } + } + } + }, + "com.amazonaws.tnb#ErrorCause": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.tnb#ErrorDetails": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 10240 + } + } + }, + "com.amazonaws.tnb#ErrorInfo": { + "type": "structure", + "members": { + "cause": { + "target": "com.amazonaws.tnb#ErrorCause", + "traits": { + "smithy.api#documentation": "Error cause.
" + } + }, + "details": { + "target": "com.amazonaws.tnb#ErrorDetails", + "traits": { + "smithy.api#documentation": "Error details.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides error information.
" + } + }, + "com.amazonaws.tnb#FunctionArtifactMeta": { + "type": "structure", + "members": { + "overrides": { + "target": "com.amazonaws.tnb#OverrideList", + "traits": { + "smithy.api#documentation": "Lists of function package overrides.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Metadata for function package artifacts.
\nArtifacts are the contents of the package descriptor file and the state of the package.
" + } + }, + "com.amazonaws.tnb#GetSolFunctionInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.tnb#GetSolFunctionInstanceInput" + }, + "output": { + "target": "com.amazonaws.tnb#GetSolFunctionInstanceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.tnb#AccessDeniedException" + }, + { + "target": "com.amazonaws.tnb#InternalServerException" + }, + { + "target": "com.amazonaws.tnb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.tnb#ThrottlingException" + }, + { + "target": "com.amazonaws.tnb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets the details of a network function instance, including the instantation state and metadata from the function package descriptor in the network function package.
\nA network function instance is a function in a function package .
", + "smithy.api#examples": [ + { + "title": "Get a Sol Network Function Instance details", + "input": { + "vnfInstanceId": "fi-b9439c34c1ef86c54" + }, + "output": { + "id": "fi-b9439c34c1ef86c54", + "arn": "arn:aws:tnb:us-west-2:123456789000:function-instance/fi-b9439c34c1ef86c54", + "nsInstanceId": "ni-07aa863e53460a2a6", + "vnfPkgId": "fp-07aa863e53460a2a6", + "vnfdId": "6625a858-2157-4d74-9197-a6ff67d51f3e", + "vnfProvider": "VNFBuilder", + "vnfProductName": "VNFBuilder-AMF", + "vnfdVersion": "1.0", + "instantiationState": "INSTANTIATED", + "instantiatedVnfInfo": { + "vnfState": "STARTED", + "vnfcResourceInfo": [ + { + "metadata": { + "cluster": "TestCluster", + "nodeGroup": "Core-EKS-TEST01-EKSNodeGroup-94BNRKWRV6MP", + "helmChart": "VnfHelmChart01" + } + } + ] + }, + "metadata": { + "createdAt": "2022-06-10T19:48:33Z", + "lastModified": "2022-06-10T19:48:33Z" + } + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/sol/vnflcm/v1/vnf_instances/{vnfInstanceId}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.tnb#GetSolFunctionInstanceInput": { + "type": "structure", + "members": { + "vnfInstanceId": { + "target": "com.amazonaws.tnb#VnfInstanceId", + "traits": { + "smithy.api#documentation": "ID of the network function.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.tnb#GetSolFunctionInstanceMetadata": { + "type": "structure", + "members": { + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The date that the resource was created.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "lastModified": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The date that the resource was last modified.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + } + }, + "traits": { + "smithy.api#documentation": "The metadata of a network function instance.
\nA network function instance is a function in a function package .
" + } + }, + "com.amazonaws.tnb#GetSolFunctionInstanceOutput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.tnb#VnfInstanceId", + "traits": { + "smithy.api#documentation": "Network function instance ID.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.tnb#VnfInstanceArn", + "traits": { + "smithy.api#documentation": "Network function instance ARN.
", + "smithy.api#required": {} + } + }, + "nsInstanceId": { + "target": "com.amazonaws.tnb#NsInstanceId", + "traits": { + "smithy.api#documentation": "Network instance ID.
", + "smithy.api#required": {} + } + }, + "vnfPkgId": { + "target": "com.amazonaws.tnb#VnfPkgId", + "traits": { + "smithy.api#documentation": "Function package ID.
", + "smithy.api#required": {} + } + }, + "vnfdId": { + "target": "com.amazonaws.tnb#VnfdId", + "traits": { + "smithy.api#documentation": "Function package descriptor ID.
", + "smithy.api#required": {} + } + }, + "vnfProvider": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Network function provider.
" + } + }, + "vnfProductName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Network function product name.
" + } + }, + "vnfdVersion": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Function package descriptor version.
" + } + }, + "instantiationState": { + "target": "com.amazonaws.tnb#VnfInstantiationState", + "traits": { + "smithy.api#documentation": "Network function instantiation state.
", + "smithy.api#required": {} + } + }, + "instantiatedVnfInfo": { + "target": "com.amazonaws.tnb#GetSolVnfInfo" + }, + "metadata": { + "target": "com.amazonaws.tnb#GetSolFunctionInstanceMetadata", + "traits": { + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.tnb#TagMap", + "traits": { + "smithy.api#documentation": "A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.tnb#GetSolFunctionPackage": { + "type": "operation", + "input": { + "target": "com.amazonaws.tnb#GetSolFunctionPackageInput" + }, + "output": { + "target": "com.amazonaws.tnb#GetSolFunctionPackageOutput" + }, + "errors": [ + { + "target": "com.amazonaws.tnb#AccessDeniedException" + }, + { + "target": "com.amazonaws.tnb#InternalServerException" + }, + { + "target": "com.amazonaws.tnb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.tnb#ThrottlingException" + }, + { + "target": "com.amazonaws.tnb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets the details of an individual function package, such as the operational state and whether the package is in use.
\nA function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network..
", + "smithy.api#examples": [ + { + "title": "Describe a function package with correct vnfPkgId", + "input": { + "vnfPkgId": "fp-07aa863e53460a2a6" + }, + "output": { + "id": "fp-07aa863e53460a2a6", + "arn": "arn:aws:tnb:us-west-2:123456789000:function-package/fp-07aa863e53460a2a6", + "onboardingState": "ONBOARDED", + "operationalState": "ENABLED", + "usageState": "IN_USE", + "vnfdId": "eefaac4a-cf5c-4b1f-869e-9d31a9fa6d71", + "vnfProvider": "VNFBuilder", + "vnfProductName": "NRF", + "vnfdVersion": "1.0.0", + "metadata": { + "createdAt": "2022-06-10T19:48:34Z", + "lastModified": "2022-06-10T21:48:33Z", + "vnfd": { + "overrides": [] + } + } + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/sol/vnfpkgm/v1/vnf_packages/{vnfPkgId}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.tnb#GetSolFunctionPackageContent": { + "type": "operation", + "input": { + "target": "com.amazonaws.tnb#GetSolFunctionPackageContentInput" + }, + "output": { + "target": "com.amazonaws.tnb#GetSolFunctionPackageContentOutput" + }, + "errors": [ + { + "target": "com.amazonaws.tnb#AccessDeniedException" + }, + { + "target": "com.amazonaws.tnb#InternalServerException" + }, + { + "target": "com.amazonaws.tnb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.tnb#ThrottlingException" + }, + { + "target": "com.amazonaws.tnb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets the contents of a function package.
\nA function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.
", + "smithy.api#examples": [ + { + "title": "Get the content of a function package", + "input": { + "accept": "application/zip", + "vnfPkgId": "fp-07aa863e53460a2a6" + }, + "output": { + "contentType": "application/zip", + "packageContent": "dGVzdCBjb250ZW50IGhlcmU=" + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/sol/vnfpkgm/v1/vnf_packages/{vnfPkgId}/package_content" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.tnb#GetSolFunctionPackageContentInput": { + "type": "structure", + "members": { + "vnfPkgId": { + "target": "com.amazonaws.tnb#VnfPkgId", + "traits": { + "smithy.api#documentation": "ID of the function package.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "accept": { + "target": "com.amazonaws.tnb#PackageContentType", + "traits": { + "smithy.api#documentation": "The format of the package that you want to download from the function packages.
", + "smithy.api#httpHeader": "Accept", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.tnb#GetSolFunctionPackageContentOutput": { + "type": "structure", + "members": { + "contentType": { + "target": "com.amazonaws.tnb#PackageContentType", + "traits": { + "smithy.api#documentation": "Indicates the media type of the resource.
", + "smithy.api#httpHeader": "Content-Type" + } + }, + "packageContent": { + "target": "smithy.api#Blob", + "traits": { + "smithy.api#documentation": "Contents of the function package.
", + "smithy.api#httpPayload": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.tnb#GetSolFunctionPackageDescriptor": { + "type": "operation", + "input": { + "target": "com.amazonaws.tnb#GetSolFunctionPackageDescriptorInput" + }, + "output": { + "target": "com.amazonaws.tnb#GetSolFunctionPackageDescriptorOutput" + }, + "errors": [ + { + "target": "com.amazonaws.tnb#AccessDeniedException" + }, + { + "target": "com.amazonaws.tnb#InternalServerException" + }, + { + "target": "com.amazonaws.tnb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.tnb#ThrottlingException" + }, + { + "target": "com.amazonaws.tnb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets a function package descriptor in a function package.
\nA function package descriptor is a .yaml file in a function package that uses the TOSCA standard to describe how the network function in the function package should run on your network.
\nA function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.
", + "smithy.api#examples": [ + { + "title": "Get the descriptor of a function package", + "input": { + "accept": "text/plain", + "vnfPkgId": "fp-07aa863e53460a2a6" + }, + "output": { + "contentType": "text/plain", + "vnfd": "dGVzdCBjb250ZW50IGhlcmU=" + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/sol/vnfpkgm/v1/vnf_packages/{vnfPkgId}/vnfd" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.tnb#GetSolFunctionPackageDescriptorInput": { + "type": "structure", + "members": { + "vnfPkgId": { + "target": "com.amazonaws.tnb#VnfPkgId", + "traits": { + "smithy.api#documentation": "ID of the function package.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "accept": { + "target": "com.amazonaws.tnb#DescriptorContentType", + "traits": { + "smithy.api#documentation": "Indicates which content types, expressed as MIME types, the client is able to understand.
", + "smithy.api#httpHeader": "Accept", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.tnb#GetSolFunctionPackageDescriptorOutput": { + "type": "structure", + "members": { + "contentType": { + "target": "com.amazonaws.tnb#DescriptorContentType", + "traits": { + "smithy.api#documentation": "Indicates the media type of the resource.
", + "smithy.api#httpHeader": "Content-Type" + } + }, + "vnfd": { + "target": "smithy.api#Blob", + "traits": { + "smithy.api#documentation": "Contents of the function package descriptor.
", + "smithy.api#httpPayload": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.tnb#GetSolFunctionPackageInput": { + "type": "structure", + "members": { + "vnfPkgId": { + "target": "com.amazonaws.tnb#VnfPkgId", + "traits": { + "smithy.api#documentation": "ID of the function package.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.tnb#GetSolFunctionPackageMetadata": { + "type": "structure", + "members": { + "vnfd": { + "target": "com.amazonaws.tnb#FunctionArtifactMeta", + "traits": { + "smithy.api#documentation": "Metadata related to the function package descriptor of the function package.
" + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The date that the resource was created.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "lastModified": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The date that the resource was last modified.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + } + }, + "traits": { + "smithy.api#documentation": "Metadata related to the function package.
\nA function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.
" + } + }, + "com.amazonaws.tnb#GetSolFunctionPackageOutput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.tnb#VnfPkgId", + "traits": { + "smithy.api#documentation": "Function package ID.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.tnb#VnfPkgArn", + "traits": { + "smithy.api#documentation": "Function package ARN.
", + "smithy.api#required": {} + } + }, + "onboardingState": { + "target": "com.amazonaws.tnb#OnboardingState", + "traits": { + "smithy.api#documentation": "Function package onboarding state.
", + "smithy.api#required": {} + } + }, + "operationalState": { + "target": "com.amazonaws.tnb#OperationalState", + "traits": { + "smithy.api#documentation": "Function package operational state.
", + "smithy.api#required": {} + } + }, + "usageState": { + "target": "com.amazonaws.tnb#UsageState", + "traits": { + "smithy.api#documentation": "Function package usage state.
", + "smithy.api#required": {} + } + }, + "vnfdId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Function package descriptor ID.
" + } + }, + "vnfProvider": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Network function provider.
" + } + }, + "vnfProductName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Network function product name.
" + } + }, + "vnfdVersion": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Function package descriptor version.
" + } + }, + "metadata": { + "target": "com.amazonaws.tnb#GetSolFunctionPackageMetadata" + }, + "tags": { + "target": "com.amazonaws.tnb#TagMap", + "traits": { + "smithy.api#documentation": "A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.tnb#GetSolInstantiatedVnfInfo": { + "type": "structure", + "members": { + "vnfState": { + "target": "com.amazonaws.tnb#VnfOperationalState", + "traits": { + "smithy.api#documentation": "State of the network function.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about a network function.
\nA network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.
" + } + }, + "com.amazonaws.tnb#GetSolNetworkInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.tnb#GetSolNetworkInstanceInput" + }, + "output": { + "target": "com.amazonaws.tnb#GetSolNetworkInstanceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.tnb#AccessDeniedException" + }, + { + "target": "com.amazonaws.tnb#InternalServerException" + }, + { + "target": "com.amazonaws.tnb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.tnb#ThrottlingException" + }, + { + "target": "com.amazonaws.tnb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets the details of the network instance.
\nA network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.
", + "smithy.api#examples": [ + { + "title": "Get a Sol Network Instance details", + "input": { + "nsInstanceId": "ni-07aa863e53460a2a6" + }, + "output": { + "id": "ni-07aa863e53460a2a6", + "arn": "arn:aws:tnb:us-west-2:123456789000:network-instance/ni-07aa863e53460a2a6", + "nsInstanceName": "CITY Instance", + "nsInstanceDescription": "Network service for CITY", + "nsdId": "6625a858-2157-4d74-9197-a6ff67d51f3e", + "nsdInfoId": "np-07aa863e53460a2a6", + "nsState": "INSTANTIATED", + "metadata": { + "createdAt": "2022-06-10T19:48:33Z", + "lastModified": "2022-06-10T19:48:33Z" + }, + "lcmOpInfo": { + "nsLcmOpOccId": "no-0d5b823eb5c2a9241" + } + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/sol/nslcm/v1/ns_instances/{nsInstanceId}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.tnb#GetSolNetworkInstanceInput": { + "type": "structure", + "members": { + "nsInstanceId": { + "target": "com.amazonaws.tnb#NsInstanceId", + "traits": { + "smithy.api#documentation": "ID of the network instance.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.tnb#GetSolNetworkInstanceMetadata": { + "type": "structure", + "members": { + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The date that the resource was created.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "lastModified": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The date that the resource was last modified.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + } + }, + "traits": { + "smithy.api#documentation": "The metadata of a network instance.
\nA network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.
" + } + }, + "com.amazonaws.tnb#GetSolNetworkInstanceOutput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.tnb#NsInstanceId", + "traits": { + "smithy.api#documentation": "Network instance ID.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.tnb#NsInstanceArn", + "traits": { + "smithy.api#documentation": "Network instance ARN.
", + "smithy.api#required": {} + } + }, + "nsInstanceName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Network instance name.
", + "smithy.api#required": {} + } + }, + "nsInstanceDescription": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Network instance description.
", + "smithy.api#required": {} + } + }, + "nsdId": { + "target": "com.amazonaws.tnb#NsdId", + "traits": { + "smithy.api#documentation": "Network service descriptor ID.
", + "smithy.api#required": {} + } + }, + "nsdInfoId": { + "target": "com.amazonaws.tnb#NsdInfoId", + "traits": { + "smithy.api#documentation": "Network service descriptor info ID.
", + "smithy.api#required": {} + } + }, + "nsState": { + "target": "com.amazonaws.tnb#NsState", + "traits": { + "smithy.api#documentation": "Network instance state.
" + } + }, + "lcmOpInfo": { + "target": "com.amazonaws.tnb#LcmOperationInfo" + }, + "metadata": { + "target": "com.amazonaws.tnb#GetSolNetworkInstanceMetadata", + "traits": { + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.tnb#TagMap", + "traits": { + "smithy.api#documentation": "A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.tnb#GetSolNetworkOperation": { + "type": "operation", + "input": { + "target": "com.amazonaws.tnb#GetSolNetworkOperationInput" + }, + "output": { + "target": "com.amazonaws.tnb#GetSolNetworkOperationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.tnb#AccessDeniedException" + }, + { + "target": "com.amazonaws.tnb#InternalServerException" + }, + { + "target": "com.amazonaws.tnb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.tnb#ThrottlingException" + }, + { + "target": "com.amazonaws.tnb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets the details of a network operation, including the tasks involved in the network operation and the status of the tasks.
\nA network operation is any operation that is done to your network, such as network instance instantiation or termination.
", + "smithy.api#examples": [ + { + "title": "Get Sol Network Instantiate operation", + "input": { + "nsLcmOpOccId": "no-0d5b823eb5c2a9241" + }, + "output": { + "id": "no-0d5b823eb5c2a9241", + "arn": "arn:aws:tnb:us-west-2:123456789000:network-operation/no-0d5b823eb5c2a9241", + "nsInstanceId": "ni-0d5b823eb5c2a9241", + "operationState": "COMPLETED", + "lcmOperationType": "INSTANTIATE", + "metadata": { + "createdAt": "2022-06-10T19:48:34Z", + "lastModified": "2022-06-10T21:48:33Z" + }, + "tasks": [ + { + "taskName": "HookExecution", + "taskContext": { + "cloudWatchLogsARN": "arn:aws:logs:us-east-1:123456789000:log-group:/aws/codebuild/TestProject:log-stream:a4dc6b0b-2ea3-48c5-bb30-636c4f376b81" + }, + "taskStatus": "IN_PROGRESS", + "taskStartTime": "2022-06-10T19:48:34Z", + "taskEndTime": "2022-06-10T21:48:33Z" + } + ] + } + }, + { + "title": "Get Sol Network Instantiate operation which has a failure", + "input": { + "nsLcmOpOccId": "no-0d5b823eb5c2a9241" + }, + "output": { + "id": "no-0d5b823eb5c2a9241", + "arn": "arn:aws:tnb:us-west-2:123456789000:network-operation/no-0d5b823eb5c2a9241", + "nsInstanceId": "ni-0d5b823eb5c2a9241", + "operationState": "FAILED", + "lcmOperationType": "INSTANTIATE", + "error": { + "title": "InternalServerException", + "detail": "The service encountered an error. Sorry for the inconvenience." + }, + "metadata": { + "createdAt": "2022-06-10T19:48:33Z", + "lastModified": "2022-06-10T19:48:33Z" + }, + "tasks": [ + { + "taskName": "HookExecution", + "taskContext": { + "cloudWatchLogsARN": "arn:aws:logs:us-east-1:123456789000:log-group:/aws/codebuild/TestProject:log-stream:a4dc6b0b-2ea3-48c5-bb30-636c4f376b81" + }, + "taskStatus": "IN_PROGRESS", + "taskStartTime": "2022-06-10T19:48:34Z", + "taskEndTime": "2022-06-10T21:48:33Z" + }, + { + "taskName": "HookExecution", + "taskErrorDetails": { + "cause": "InternalServerException", + "details": "The service encountered an error. Sorry for the inconvenience." + }, + "taskStatus": "ERROR", + "taskStartTime": "2022-06-10T19:48:34Z", + "taskEndTime": "2022-06-10T21:48:33Z" + } + ] + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/sol/nslcm/v1/ns_lcm_op_occs/{nsLcmOpOccId}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.tnb#GetSolNetworkOperationInput": { + "type": "structure", + "members": { + "nsLcmOpOccId": { + "target": "com.amazonaws.tnb#NsLcmOpOccId", + "traits": { + "smithy.api#documentation": "The identifier of the operation occurrence.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.tnb#GetSolNetworkOperationMetadata": { + "type": "structure", + "members": { + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The date that the resource was created.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "lastModified": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The date that the resource was last modified.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + } + }, + "traits": { + "smithy.api#documentation": "Metadata related to a network operation occurence.
\nA network operation is any operation that is done to your network, such as network instance instantiation or termination.
" + } + }, + "com.amazonaws.tnb#GetSolNetworkOperationOutput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.tnb#NsLcmOpOccId", + "traits": { + "smithy.api#documentation": "ID of this network operation occurrence.
" + } + }, + "arn": { + "target": "com.amazonaws.tnb#NsLcmOpOccArn", + "traits": { + "smithy.api#documentation": "Network operation ARN.
", + "smithy.api#required": {} + } + }, + "operationState": { + "target": "com.amazonaws.tnb#NsLcmOperationState", + "traits": { + "smithy.api#documentation": "The state of the network operation.
" + } + }, + "nsInstanceId": { + "target": "com.amazonaws.tnb#NsInstanceId", + "traits": { + "smithy.api#documentation": "ID of the network operation instance.
" + } + }, + "lcmOperationType": { + "target": "com.amazonaws.tnb#LcmOperationType", + "traits": { + "smithy.api#documentation": "Type of the operation represented by this occurrence.
" + } + }, + "error": { + "target": "com.amazonaws.tnb#ProblemDetails", + "traits": { + "smithy.api#documentation": "Error related to this specific network operation occurence.
" + } + }, + "metadata": { + "target": "com.amazonaws.tnb#GetSolNetworkOperationMetadata", + "traits": { + "smithy.api#documentation": "Metadata of this network operation occurrence.
" + } + }, + "tasks": { + "target": "com.amazonaws.tnb#GetSolNetworkOperationTasksList", + "traits": { + "smithy.api#documentation": "All tasks associated with this operation occurrence.
" + } + }, + "tags": { + "target": "com.amazonaws.tnb#TagMap", + "traits": { + "smithy.api#documentation": "A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.tnb#GetSolNetworkOperationTaskDetails": { + "type": "structure", + "members": { + "taskName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Task name.
" + } + }, + "taskContext": { + "target": "com.amazonaws.tnb#StringMap", + "traits": { + "smithy.api#documentation": "Context for the network operation task.
" + } + }, + "taskErrorDetails": { + "target": "com.amazonaws.tnb#ErrorInfo", + "traits": { + "smithy.api#documentation": "Task error details.
" + } + }, + "taskStatus": { + "target": "com.amazonaws.tnb#TaskStatus", + "traits": { + "smithy.api#documentation": "Task status.
" + } + }, + "taskStartTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "Task start time.
", + "smithy.api#timestampFormat": "date-time" + } + }, + "taskEndTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "Task end time.
", + "smithy.api#timestampFormat": "date-time" + } + } + }, + "traits": { + "smithy.api#documentation": "Gets the details of a network operation.
\nA network operation is any operation that is done to your network, such as network instance instantiation or termination.
" + } + }, + "com.amazonaws.tnb#GetSolNetworkOperationTasksList": { + "type": "list", + "member": { + "target": "com.amazonaws.tnb#GetSolNetworkOperationTaskDetails" + } + }, + "com.amazonaws.tnb#GetSolNetworkPackage": { + "type": "operation", + "input": { + "target": "com.amazonaws.tnb#GetSolNetworkPackageInput" + }, + "output": { + "target": "com.amazonaws.tnb#GetSolNetworkPackageOutput" + }, + "errors": [ + { + "target": "com.amazonaws.tnb#AccessDeniedException" + }, + { + "target": "com.amazonaws.tnb#InternalServerException" + }, + { + "target": "com.amazonaws.tnb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.tnb#ThrottlingException" + }, + { + "target": "com.amazonaws.tnb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets the details of a network package.
\nA network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.
", + "smithy.api#examples": [ + { + "title": "Describe an individual Sol network package", + "input": { + "nsdInfoId": "np-0d5b823eb5c2a9241" + }, + "output": { + "id": "np-0d5b823eb5c2a9241", + "arn": "arn:aws:tnb:us-west-2:123456789000:network-package/np-0d5b823eb5c2a9241", + "nsdId": "be1abe66-1fcc-11ec-9621-0242ac130002", + "nsdName": "Sample-City", + "nsdVersion": "1.0", + "vnfPkgIds": [ + "fp-0b627c4a170a97f79", + "fp-8c253b2e898d23f92" + ], + "nsdOnboardingState": "ONBOARDED", + "nsdOperationalState": "ENABLED", + "nsdUsageState": "IN_USE", + "metadata": { + "createdAt": "2022-06-10T19:48:34Z", + "lastModified": "2022-06-10T21:48:33Z", + "nsd": { + "overrides": [ + { + "name": "cidr_block", + "defaultValue": "10.0.0.0/24" + }, + { + "name": "some_vnf.vnf_prop" + } + ] + } + } + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/sol/nsd/v1/ns_descriptors/{nsdInfoId}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.tnb#GetSolNetworkPackageContent": { + "type": "operation", + "input": { + "target": "com.amazonaws.tnb#GetSolNetworkPackageContentInput" + }, + "output": { + "target": "com.amazonaws.tnb#GetSolNetworkPackageContentOutput" + }, + "errors": [ + { + "target": "com.amazonaws.tnb#AccessDeniedException" + }, + { + "target": "com.amazonaws.tnb#InternalServerException" + }, + { + "target": "com.amazonaws.tnb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.tnb#ThrottlingException" + }, + { + "target": "com.amazonaws.tnb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets the contents of a network package.
\nA network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.
", + "smithy.api#examples": [ + { + "title": "Get a network package Content", + "input": { + "accept": "application/zip", + "nsdInfoId": "np-0d5b823eb5c2a9241" + }, + "output": { + "contentType": "application/zip", + "nsdContent": "dGVzdCBjb250ZW50IGhlcmU=" + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/sol/nsd/v1/ns_descriptors/{nsdInfoId}/nsd_content" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.tnb#GetSolNetworkPackageContentInput": { + "type": "structure", + "members": { + "nsdInfoId": { + "target": "com.amazonaws.tnb#NsdInfoId", + "traits": { + "smithy.api#documentation": "ID of the network service descriptor in the network package.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "accept": { + "target": "com.amazonaws.tnb#PackageContentType", + "traits": { + "smithy.api#documentation": "The format of the package you want to download from the network package.
", + "smithy.api#httpHeader": "Accept", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.tnb#GetSolNetworkPackageContentOutput": { + "type": "structure", + "members": { + "contentType": { + "target": "com.amazonaws.tnb#PackageContentType", + "traits": { + "smithy.api#documentation": "Indicates the media type of the resource.
", + "smithy.api#httpHeader": "Content-Type" + } + }, + "nsdContent": { + "target": "smithy.api#Blob", + "traits": { + "smithy.api#documentation": "Content of the network service descriptor in the network package.
", + "smithy.api#httpPayload": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.tnb#GetSolNetworkPackageDescriptor": { + "type": "operation", + "input": { + "target": "com.amazonaws.tnb#GetSolNetworkPackageDescriptorInput" + }, + "output": { + "target": "com.amazonaws.tnb#GetSolNetworkPackageDescriptorOutput" + }, + "errors": [ + { + "target": "com.amazonaws.tnb#AccessDeniedException" + }, + { + "target": "com.amazonaws.tnb#InternalServerException" + }, + { + "target": "com.amazonaws.tnb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.tnb#ThrottlingException" + }, + { + "target": "com.amazonaws.tnb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets the content of the network service descriptor.
\nA network service descriptor is a .yaml file in a network package that uses the TOSCA standard to describe the network functions you want to deploy and the Amazon Web Services infrastructure you want to deploy the network functions on.
", + "smithy.api#examples": [ + { + "title": "Get the descriptor of a Network Pacakge", + "input": { + "nsdInfoId": "np-0d5b823eb5c2a9241" + }, + "output": { + "contentType": "text/plain", + "nsd": "dGVzdCBjb250ZW50IGhlcmU=" + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/sol/nsd/v1/ns_descriptors/{nsdInfoId}/nsd" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.tnb#GetSolNetworkPackageDescriptorInput": { + "type": "structure", + "members": { + "nsdInfoId": { + "target": "com.amazonaws.tnb#NsdInfoId", + "traits": { + "smithy.api#documentation": "ID of the network service descriptor in the network package.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.tnb#GetSolNetworkPackageDescriptorOutput": { + "type": "structure", + "members": { + "contentType": { + "target": "com.amazonaws.tnb#DescriptorContentType", + "traits": { + "smithy.api#documentation": "Indicates the media type of the resource.
", + "smithy.api#httpHeader": "Content-Type" + } + }, + "nsd": { + "target": "smithy.api#Blob", + "traits": { + "smithy.api#documentation": "Contents of the network service descriptor in the network package.
", + "smithy.api#httpPayload": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.tnb#GetSolNetworkPackageInput": { + "type": "structure", + "members": { + "nsdInfoId": { + "target": "com.amazonaws.tnb#NsdInfoId", + "traits": { + "smithy.api#documentation": "ID of the network service descriptor in the network package.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.tnb#GetSolNetworkPackageMetadata": { + "type": "structure", + "members": { + "nsd": { + "target": "com.amazonaws.tnb#NetworkArtifactMeta", + "traits": { + "smithy.api#documentation": "Metadata related to the onboarded network service descriptor in the network package.
" + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The date that the resource was created.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "lastModified": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The date that the resource was last modified.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + } + }, + "traits": { + "smithy.api#documentation": "Metadata associated with a network package.
\nA network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.
" + } + }, + "com.amazonaws.tnb#GetSolNetworkPackageOutput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.tnb#NsdInfoId", + "traits": { + "smithy.api#documentation": "Network package ID.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.tnb#NsdInfoArn", + "traits": { + "smithy.api#documentation": "Network package ARN.
", + "smithy.api#required": {} + } + }, + "nsdOnboardingState": { + "target": "com.amazonaws.tnb#NsdOnboardingState", + "traits": { + "smithy.api#documentation": "Network service descriptor onboarding state.
", + "smithy.api#required": {} + } + }, + "nsdOperationalState": { + "target": "com.amazonaws.tnb#NsdOperationalState", + "traits": { + "smithy.api#documentation": "Network service descriptor operational state.
", + "smithy.api#required": {} + } + }, + "nsdUsageState": { + "target": "com.amazonaws.tnb#NsdUsageState", + "traits": { + "smithy.api#documentation": "Network service descriptor usage state.
", + "smithy.api#required": {} + } + }, + "nsdId": { + "target": "com.amazonaws.tnb#NsdId", + "traits": { + "smithy.api#documentation": "Network service descriptor ID.
", + "smithy.api#required": {} + } + }, + "nsdName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Network service descriptor name.
", + "smithy.api#required": {} + } + }, + "nsdVersion": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Network service descriptor version.
", + "smithy.api#required": {} + } + }, + "vnfPkgIds": { + "target": "com.amazonaws.tnb#VnfPkgIdList", + "traits": { + "smithy.api#documentation": "Identifies the function package for the function package descriptor referenced by the onboarded network package.
", + "smithy.api#required": {} + } + }, + "metadata": { + "target": "com.amazonaws.tnb#GetSolNetworkPackageMetadata", + "traits": { + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.tnb#TagMap", + "traits": { + "smithy.api#documentation": "A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.tnb#GetSolVnfInfo": { + "type": "structure", + "members": { + "vnfState": { + "target": "com.amazonaws.tnb#VnfOperationalState", + "traits": { + "smithy.api#documentation": "State of the network function instance.
" + } + }, + "vnfcResourceInfo": { + "target": "com.amazonaws.tnb#GetSolVnfcResourceInfoList", + "traits": { + "smithy.api#documentation": "Compute info used by the network function instance.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the network function.
\nA network function instance is a function in a function package .
" + } + }, + "com.amazonaws.tnb#GetSolVnfcResourceInfo": { + "type": "structure", + "members": { + "metadata": { + "target": "com.amazonaws.tnb#GetSolVnfcResourceInfoMetadata", + "traits": { + "smithy.api#documentation": "The metadata of the network function compute.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details of resource associated with a network function.
\nA network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.
" + } + }, + "com.amazonaws.tnb#GetSolVnfcResourceInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.tnb#GetSolVnfcResourceInfo" + } + }, + "com.amazonaws.tnb#GetSolVnfcResourceInfoMetadata": { + "type": "structure", + "members": { + "nodeGroup": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Information about the node group.
" + } + }, + "cluster": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Information about the cluster.
" + } + }, + "helmChart": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Information about the helm chart.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The metadata of a network function.
\nA network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.
" + } + }, + "com.amazonaws.tnb#InstantiateSolNetworkInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.tnb#InstantiateSolNetworkInstanceInput" + }, + "output": { + "target": "com.amazonaws.tnb#InstantiateSolNetworkInstanceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.tnb#AccessDeniedException" + }, + { + "target": "com.amazonaws.tnb#InternalServerException" + }, + { + "target": "com.amazonaws.tnb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.tnb#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.tnb#ThrottlingException" + }, + { + "target": "com.amazonaws.tnb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Instantiates a network instance.
\nA network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.
\nBefore you can instantiate a network instance, you have to create a network instance. For more information, see CreateSolNetworkInstance.
", + "smithy.api#examples": [ + { + "title": "Instantiate a Sol Network Instance", + "input": { + "nsInstanceId": "ni-0d5b823eb5c2a9241" + }, + "output": { + "nsLcmOpOccId": "no-0d5b823eb5c2a9241" + } + }, + { + "title": "Instantiate a Sol Network Instance with Overrides", + "input": { + "nsInstanceId": "ni-0d5b823eb5c2a9241", + "additionalParamsForNs": { + "cidr_block": "10.0.0.0/16", + "availability_zone": "us-west-2a" + } + }, + "output": { + "nsLcmOpOccId": "no-0d5b823eb5c2a9241" + } + } + ], + "smithy.api#http": { + "method": "POST", + "uri": "/sol/nslcm/v1/ns_instances/{nsInstanceId}/instantiate", + "code": 201 + } + } + }, + "com.amazonaws.tnb#InstantiateSolNetworkInstanceInput": { + "type": "structure", + "members": { + "nsInstanceId": { + "target": "com.amazonaws.tnb#NsInstanceId", + "traits": { + "smithy.api#documentation": "ID of the network instance.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "dryRun": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
Provides values for the configurable properties.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.tnb#InstantiateSolNetworkInstanceOutput": { + "type": "structure", + "members": { + "nsLcmOpOccId": { + "target": "com.amazonaws.tnb#NsLcmOpOccId", + "traits": { + "smithy.api#documentation": "The identifier of the network instance.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.tnb#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Unexpected error occurred. Problem on the server.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.tnb#LcmOperationInfo": { + "type": "structure", + "members": { + "nsLcmOpOccId": { + "target": "com.amazonaws.tnb#NsLcmOpOccId", + "traits": { + "smithy.api#documentation": "The identifier of the latest network lifecycle management operation occurrence.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Lifecycle management operation details on the network instance.
\nLifecycle management operations are deploy, update, or delete operations.
" + } + }, + "com.amazonaws.tnb#LcmOperationType": { + "type": "enum", + "members": { + "INSTANTIATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSTANTIATE" + } + }, + "UPDATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE" + } + }, + "TERMINATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TERMINATE" + } + } + } + }, + "com.amazonaws.tnb#ListSolFunctionInstanceInfo": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.tnb#VnfInstanceId", + "traits": { + "smithy.api#documentation": "Network function instance ID.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.tnb#VnfInstanceArn", + "traits": { + "smithy.api#documentation": "Network function instance ARN.
", + "smithy.api#required": {} + } + }, + "nsInstanceId": { + "target": "com.amazonaws.tnb#NsInstanceId", + "traits": { + "smithy.api#documentation": "Network instance ID.
", + "smithy.api#required": {} + } + }, + "vnfPkgId": { + "target": "com.amazonaws.tnb#VnfPkgId", + "traits": { + "smithy.api#documentation": "Function package ID.
", + "smithy.api#required": {} + } + }, + "vnfPkgName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Function package name.
" + } + }, + "instantiationState": { + "target": "com.amazonaws.tnb#VnfInstantiationState", + "traits": { + "smithy.api#documentation": "Network function instance instantiation state.
", + "smithy.api#required": {} + } + }, + "instantiatedVnfInfo": { + "target": "com.amazonaws.tnb#GetSolInstantiatedVnfInfo" + }, + "metadata": { + "target": "com.amazonaws.tnb#ListSolFunctionInstanceMetadata", + "traits": { + "smithy.api#documentation": "Network function instance metadata.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Lists information about a network function instance.
\nA network function instance is a function in a function package .
" + } + }, + "com.amazonaws.tnb#ListSolFunctionInstanceMetadata": { + "type": "structure", + "members": { + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "When the network function instance was created.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "lastModified": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "When the network function instance was last modified.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + } + }, + "traits": { + "smithy.api#documentation": "Lists network function instance metadata.
\nA network function instance is a function in a function package .
" + } + }, + "com.amazonaws.tnb#ListSolFunctionInstanceResources": { + "type": "list", + "member": { + "target": "com.amazonaws.tnb#ListSolFunctionInstanceInfo" + } + }, + "com.amazonaws.tnb#ListSolFunctionInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.tnb#ListSolFunctionInstancesInput" + }, + "output": { + "target": "com.amazonaws.tnb#ListSolFunctionInstancesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.tnb#AccessDeniedException" + }, + { + "target": "com.amazonaws.tnb#InternalServerException" + }, + { + "target": "com.amazonaws.tnb#ThrottlingException" + }, + { + "target": "com.amazonaws.tnb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists network function instances.
\nA network function instance is a function in a function package .
", + "smithy.api#examples": [ + { + "title": "List Sol Function instances", + "input": {}, + "output": { + "functionInstances": [ + { + "id": "fi-b9439c34c1ef86c54", + "arn": "arn:aws:tnb:us-west-2:123456789000:function-instance/fi-b9439c34c1ef86c54", + "nsInstanceId": "ni-07aa863e53460a2a6", + "vnfPkgId": "fp-07aa863e53460a2a6", + "instantiationState": "INSTANTIATED", + "instantiatedVnfInfo": { + "vnfState": "STARTED" + }, + "metadata": { + "createdAt": "2022-06-10T19:48:34Z", + "lastModified": "2022-06-10T21:48:33Z" + } + }, + { + "id": "fi-b9439c34c1efabcd1", + "arn": "arn:aws:tnb:us-west-2:123456789000:function-instance/fi-b9439c34c1efabcd1", + "nsInstanceId": "ni-07aa863e53460a123", + "vnfPkgId": "fp-146a863e53460a2a6", + "instantiationState": "INSTANTIATED", + "instantiatedVnfInfo": { + "vnfState": "STOPPED" + }, + "metadata": { + "createdAt": "2022-06-10T11:48:34Z", + "lastModified": "2023-06-28T21:48:33Z" + } + } + ] + } + }, + { + "title": "List Sol Function Instances with nextToken and maxResults", + "input": { + "maxResults": 25, + "nextToken": "" + }, + "output": { + "functionInstances": [ + { + "id": "fi-b9439c34c1ef86c54", + "arn": "arn:aws:tnb:us-west-2:123456789000:function-instance/fi-b9439c34c1ef86c54", + "nsInstanceId": "ni-07aa863e53460a2a6", + "vnfPkgId": "fp-07aa863e53460a2a6", + "instantiationState": "INSTANTIATED", + "instantiatedVnfInfo": { + "vnfState": "STARTED" + }, + "metadata": { + "createdAt": "2022-06-10T19:48:34Z", + "lastModified": "2022-06-10T21:48:33Z" + } + } + ] + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/sol/vnflcm/v1/vnf_instances" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "functionInstances" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.tnb#ListSolFunctionInstancesInput": { + "type": "structure", + "members": { + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of results to include in the response.
", + "smithy.api#httpQuery": "max_results", + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "nextToken": { + "target": "com.amazonaws.tnb#PaginationToken", + "traits": { + "smithy.api#documentation": "The token for the next page of results.
", + "smithy.api#httpQuery": "nextpage_opaque_marker" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.tnb#ListSolFunctionInstancesOutput": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.tnb#PaginationToken", + "traits": { + "smithy.api#documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Network function instances.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.tnb#ListSolFunctionPackageInfo": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.tnb#VnfPkgId", + "traits": { + "smithy.api#documentation": "ID of the function package.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.tnb#VnfPkgArn", + "traits": { + "smithy.api#documentation": "Function package ARN.
", + "smithy.api#required": {} + } + }, + "onboardingState": { + "target": "com.amazonaws.tnb#OnboardingState", + "traits": { + "smithy.api#documentation": "Onboarding state of the function package.
", + "smithy.api#required": {} + } + }, + "operationalState": { + "target": "com.amazonaws.tnb#OperationalState", + "traits": { + "smithy.api#documentation": "Operational state of the function package.
", + "smithy.api#required": {} + } + }, + "usageState": { + "target": "com.amazonaws.tnb#UsageState", + "traits": { + "smithy.api#documentation": "Usage state of the function package.
", + "smithy.api#required": {} + } + }, + "vnfdId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Identifies the function package and the function package descriptor.
" + } + }, + "vnfProvider": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Provider of the function package and the function package descriptor.
" + } + }, + "vnfProductName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The product name for the network function.
" + } + }, + "vnfdVersion": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Identifies the version of the function package descriptor.
" + } + }, + "metadata": { + "target": "com.amazonaws.tnb#ListSolFunctionPackageMetadata", + "traits": { + "smithy.api#documentation": "The metadata of the function package.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about a function package.
\nA function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.
" + } + }, + "com.amazonaws.tnb#ListSolFunctionPackageMetadata": { + "type": "structure", + "members": { + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The date that the resource was created.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "lastModified": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The date that the resource was last modified.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + } + }, + "traits": { + "smithy.api#documentation": "Details for the function package metadata.
\nA function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.
" + } + }, + "com.amazonaws.tnb#ListSolFunctionPackageResources": { + "type": "list", + "member": { + "target": "com.amazonaws.tnb#ListSolFunctionPackageInfo" + } + }, + "com.amazonaws.tnb#ListSolFunctionPackages": { + "type": "operation", + "input": { + "target": "com.amazonaws.tnb#ListSolFunctionPackagesInput" + }, + "output": { + "target": "com.amazonaws.tnb#ListSolFunctionPackagesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.tnb#AccessDeniedException" + }, + { + "target": "com.amazonaws.tnb#InternalServerException" + }, + { + "target": "com.amazonaws.tnb#ThrottlingException" + }, + { + "target": "com.amazonaws.tnb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists information about function packages.
\nA function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.
", + "smithy.api#examples": [ + { + "title": "List information about multiple function packages without PaginationToken", + "input": { + "maxResults": 25, + "nextToken": "" + }, + "output": { + "nextToken": "ug2E9SheCpyAmeLItmHF99a8GNI6yAHxXIvgBkdiA2ixKvqdhYpNBLWHDl6vGnWt7Y4CB6m1Dkz86gSwcDouMO1pSrN%2BlGY2kbNtfTeMgnuB6bmwP/UU12r7MkHQyPCWMYG8OuCXkDBOYeX8qjRDTJ5vxAyrwtynaB6XDNDZA2DscCjcD7kpNzf3xlPRCwd6", + "functionPackages": [ + { + "id": "fp-07aa863e53460a2a6", + "arn": "arn:aws:tnb:us-west-2:123456789000:function-package/fp-07aa863e53460a2a6", + "onboardingState": "ONBOARDED", + "operationalState": "ENABLED", + "usageState": "IN_USE", + "vnfdId": "arn:aws:tnb:123456789000:vnf/nrf", + "vnfProvider": "VNFBuilder", + "vnfProductName": "NRF", + "vnfdVersion": "1.0", + "metadata": { + "createdAt": "2022-06-10T19:48:34Z", + "lastModified": "2022-06-10T21:48:33Z" + } + } + ] + } + }, + { + "title": "List information about multiple function packages with PaginationToken", + "input": { + "maxResults": 25, + "nextToken": "ug2E9SheCpyAmeLItmHF99a8GNI6yAHxXIvgBkdiA2ixKvqdhYpNBLWHDl6vGnWt7Y4CB6m1Dkz86gSwcDouMO1pSrN%2BlGY2kbNtfTeMgnuB6bmwP/UU12r7MkHQyPCWMYG8OuCXkDBOYeX8qjRDTJ5vxAyrwtynaB6XDNDZA2DscCjcD7kpNzf3xlPRCwd6" + }, + "output": { + "nextToken": "ug2E9SheCpyAmeLItmHF98uvZTosFhZ1wyglENkc3UZ12UuRLmtGtojRynFjRR5zW%2FycBL6QX8AU%2B1IRWL%2BVjNNL7KBiaD87KM9WcUMQzryLtOazGHexujJncJJ0YGsxSLSrmPGx7dM1EoNKX8oxYA%3D%3D", + "functionPackages": [ + { + "id": "fp-07aa863e53460a2a6", + "arn": "arn:aws:tnb:us-west-2:123456789000:function-package/fp-07aa863e53460a2a6", + "onboardingState": "ONBOARDED", + "operationalState": "ENABLED", + "usageState": "IN_USE", + "vnfdId": "arn:aws:tnb:123456789000:vnf/nrf", + "vnfProvider": "VNFBuilder", + "vnfProductName": "NRF", + "vnfdVersion": "1.0", + "metadata": { + "createdAt": "2022-06-10T19:48:34Z", + "lastModified": "2022-06-10T21:48:33Z" + } + } + ] + } + }, + { + "title": "No more function packages to return", + "input": { + "maxResults": 25, + "nextToken": "ug2E9SheCpyAmeLItmHF98uvZTosFhZ1wyglENkc3UZ12UuRLmtGtojRynFjRR5zW%2FycBL6QX8AU%2B1IRWL%2BVjNNL7KBiaD87KM9WcUMQzryLtOazGHexujJncJJ0YGsxSLSrmPGx7dM1EoNKX8oxYA%3D%3D" + }, + "output": { + "functionPackages": [] + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/sol/vnfpkgm/v1/vnf_packages" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "functionPackages" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.tnb#ListSolFunctionPackagesInput": { + "type": "structure", + "members": { + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of results to include in the response.
", + "smithy.api#httpQuery": "max_results", + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "nextToken": { + "target": "com.amazonaws.tnb#PaginationToken", + "traits": { + "smithy.api#documentation": "The token for the next page of results.
", + "smithy.api#httpQuery": "nextpage_opaque_marker" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.tnb#ListSolFunctionPackagesOutput": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.tnb#PaginationToken", + "traits": { + "smithy.api#documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Function packages. A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.tnb#ListSolNetworkInstanceInfo": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.tnb#NsInstanceId", + "traits": { + "smithy.api#documentation": "ID of the network instance.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.tnb#NsInstanceArn", + "traits": { + "smithy.api#documentation": "Network instance ARN.
", + "smithy.api#required": {} + } + }, + "nsInstanceName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Human-readable name of the network instance.
", + "smithy.api#required": {} + } + }, + "nsInstanceDescription": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Human-readable description of the network instance.
", + "smithy.api#required": {} + } + }, + "nsdId": { + "target": "com.amazonaws.tnb#NsdId", + "traits": { + "smithy.api#documentation": "ID of the network service descriptor in the network package.
", + "smithy.api#required": {} + } + }, + "nsdInfoId": { + "target": "com.amazonaws.tnb#NsdInfoId", + "traits": { + "smithy.api#documentation": "ID of the network service descriptor in the network package.
", + "smithy.api#required": {} + } + }, + "nsState": { + "target": "com.amazonaws.tnb#NsState", + "traits": { + "smithy.api#documentation": "The state of the network instance.
", + "smithy.api#required": {} + } + }, + "metadata": { + "target": "com.amazonaws.tnb#ListSolNetworkInstanceMetadata", + "traits": { + "smithy.api#documentation": "The metadata of the network instance.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Info about the specific network instance.
\nA network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.
" + } + }, + "com.amazonaws.tnb#ListSolNetworkInstanceMetadata": { + "type": "structure", + "members": { + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The date that the resource was created.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "lastModified": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The date that the resource was last modified.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + } + }, + "traits": { + "smithy.api#documentation": "Metadata details for a network instance.
\nA network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.
" + } + }, + "com.amazonaws.tnb#ListSolNetworkInstanceResources": { + "type": "list", + "member": { + "target": "com.amazonaws.tnb#ListSolNetworkInstanceInfo" + } + }, + "com.amazonaws.tnb#ListSolNetworkInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.tnb#ListSolNetworkInstancesInput" + }, + "output": { + "target": "com.amazonaws.tnb#ListSolNetworkInstancesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.tnb#AccessDeniedException" + }, + { + "target": "com.amazonaws.tnb#InternalServerException" + }, + { + "target": "com.amazonaws.tnb#ThrottlingException" + }, + { + "target": "com.amazonaws.tnb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists your network instances.
\nA network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.
", + "smithy.api#examples": [ + { + "title": "List Sol Network Instantiate instances", + "input": {}, + "output": { + "networkInstances": [ + { + "id": "ni-07aa863e53460a2a6", + "arn": "arn:aws:tnb:us-west-2:123456789000:network-instance/ni-07aa863e53460a2a6", + "nsInstanceName": "CITY Instance", + "nsInstanceDescription": "Network service for CITY", + "nsdId": "e851fd14-abe3-4535-85e6-6060636fd519", + "nsdInfoId": "np-0d5b823eb5c2a9241", + "nsState": "INSTANTIATED", + "metadata": { + "createdAt": "2022-06-10T19:48:34Z", + "lastModified": "2022-06-10T21:48:33Z" + } + } + ] + } + }, + { + "title": "List Sol Network Instances with nextToken and maxResults", + "input": { + "maxResults": 25, + "nextToken": "" + }, + "output": { + "networkInstances": [ + { + "id": "ni-07aa863e53460a2a6", + "arn": "arn:aws:tnb:us-west-2:123456789000:network-instance/ni-07aa863e53460a2a6", + "nsInstanceName": "CITY Instance", + "nsInstanceDescription": "Network service for CITY", + "nsdId": "e851fd14-abe3-4535-85e6-6060636fd519", + "nsdInfoId": "np-0d5b823eb5c2a9241", + "nsState": "INSTANTIATED", + "metadata": { + "createdAt": "2022-06-10T19:48:34Z", + "lastModified": "2022-06-10T21:48:33Z" + } + } + ] + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/sol/nslcm/v1/ns_instances" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "networkInstances" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.tnb#ListSolNetworkInstancesInput": { + "type": "structure", + "members": { + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of results to include in the response.
", + "smithy.api#httpQuery": "max_results", + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "nextToken": { + "target": "com.amazonaws.tnb#PaginationToken", + "traits": { + "smithy.api#documentation": "The token for the next page of results.
", + "smithy.api#httpQuery": "nextpage_opaque_marker" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.tnb#ListSolNetworkInstancesOutput": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.tnb#PaginationToken", + "traits": { + "smithy.api#documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Lists network instances.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.tnb#ListSolNetworkOperations": { + "type": "operation", + "input": { + "target": "com.amazonaws.tnb#ListSolNetworkOperationsInput" + }, + "output": { + "target": "com.amazonaws.tnb#ListSolNetworkOperationsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.tnb#AccessDeniedException" + }, + { + "target": "com.amazonaws.tnb#InternalServerException" + }, + { + "target": "com.amazonaws.tnb#ThrottlingException" + }, + { + "target": "com.amazonaws.tnb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists details for a network operation, including when the operation started and the status of the operation.
\nA network operation is any operation that is done to your network, such as network instance instantiation or termination.
", + "smithy.api#examples": [ + { + "title": "List Sol Network Instantiate operations", + "input": {}, + "output": { + "networkOperations": [ + { + "id": "no-0d5b823eb5c2a9241", + "arn": "arn:aws:tnb:us-west-2:123456789000:network-operation/no-0d5b823eb5c2a9241", + "nsInstanceId": "ni-0d5b823eb5c2a9241", + "operationState": "COMPLETED", + "lcmOperationType": "INSTANTIATE", + "metadata": { + "createdAt": "2022-06-10T19:48:34Z", + "lastModified": "2022-06-10T21:48:33Z" + } + } + ] + } + }, + { + "title": "List Sol Network Instantiate operations with nextToken and maxResults", + "input": { + "maxResults": 25, + "nextToken": "" + }, + "output": { + "networkOperations": [ + { + "id": "no-0d5b823eb5c2a9241", + "arn": "arn:aws:tnb:us-west-2:123456789000:network-operation/no-0d5b823eb5c2a9241", + "nsInstanceId": "ni-0d5b823eb5c2a9241", + "operationState": "COMPLETED", + "lcmOperationType": "INSTANTIATE", + "error": { + "title": "InsufficientInstanceCapacity", + "detail": "An error occurred (InsufficientInstanceCapacity) when calling the RunInstances operation (reached max retries: 4). We currently do not have sufficient capacity in the Availability Zone you requested" + }, + "metadata": { + "createdAt": "2022-06-10T19:48:33Z", + "lastModified": "2022-06-10T19:48:33Z" + } + } + ] + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/sol/nslcm/v1/ns_lcm_op_occs" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "networkOperations" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.tnb#ListSolNetworkOperationsInfo": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.tnb#NsLcmOpOccId", + "traits": { + "smithy.api#documentation": "ID of this network operation.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.tnb#NsLcmOpOccArn", + "traits": { + "smithy.api#documentation": "Network operation ARN.
", + "smithy.api#required": {} + } + }, + "operationState": { + "target": "com.amazonaws.tnb#NsLcmOperationState", + "traits": { + "smithy.api#documentation": "The state of the network operation.
", + "smithy.api#required": {} + } + }, + "nsInstanceId": { + "target": "com.amazonaws.tnb#NsInstanceId", + "traits": { + "smithy.api#documentation": "ID of the network instance related to this operation.
", + "smithy.api#required": {} + } + }, + "lcmOperationType": { + "target": "com.amazonaws.tnb#LcmOperationType", + "traits": { + "smithy.api#documentation": "Type of lifecycle management network operation.
", + "smithy.api#required": {} + } + }, + "error": { + "target": "com.amazonaws.tnb#ProblemDetails", + "traits": { + "smithy.api#documentation": "Error related to this specific network operation.
" + } + }, + "metadata": { + "target": "com.amazonaws.tnb#ListSolNetworkOperationsMetadata", + "traits": { + "smithy.api#documentation": "Metadata related to this network operation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information parameters for a network operation.
" + } + }, + "com.amazonaws.tnb#ListSolNetworkOperationsInput": { + "type": "structure", + "members": { + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of results to include in the response.
", + "smithy.api#httpQuery": "max_results", + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "nextToken": { + "target": "com.amazonaws.tnb#PaginationToken", + "traits": { + "smithy.api#documentation": "The token for the next page of results.
", + "smithy.api#httpQuery": "nextpage_opaque_marker" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.tnb#ListSolNetworkOperationsMetadata": { + "type": "structure", + "members": { + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The date that the resource was created.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "lastModified": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The date that the resource was last modified.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + } + }, + "traits": { + "smithy.api#documentation": "Metadata related to a network operation.
\nA network operation is any operation that is done to your network, such as network instance instantiation or termination.
" + } + }, + "com.amazonaws.tnb#ListSolNetworkOperationsOutput": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.tnb#PaginationToken", + "traits": { + "smithy.api#documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Lists network operation occurrences. Lifecycle management operations are deploy, update, or delete operations.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.tnb#ListSolNetworkOperationsResources": { + "type": "list", + "member": { + "target": "com.amazonaws.tnb#ListSolNetworkOperationsInfo" + } + }, + "com.amazonaws.tnb#ListSolNetworkPackageInfo": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.tnb#NsdInfoId", + "traits": { + "smithy.api#documentation": "ID of the individual network package.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.tnb#NsdInfoArn", + "traits": { + "smithy.api#documentation": "Network package ARN.
", + "smithy.api#required": {} + } + }, + "nsdOnboardingState": { + "target": "com.amazonaws.tnb#NsdOnboardingState", + "traits": { + "smithy.api#documentation": "Onboarding state of the network service descriptor in the network package.
", + "smithy.api#required": {} + } + }, + "nsdOperationalState": { + "target": "com.amazonaws.tnb#NsdOperationalState", + "traits": { + "smithy.api#documentation": "Operational state of the network service descriptor in the network package.
", + "smithy.api#required": {} + } + }, + "nsdUsageState": { + "target": "com.amazonaws.tnb#NsdUsageState", + "traits": { + "smithy.api#documentation": "Usage state of the network service descriptor in the network package.
", + "smithy.api#required": {} + } + }, + "nsdId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "ID of the network service descriptor on which the network package is based.
" + } + }, + "nsdName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Name of the onboarded network service descriptor in the network package.
" + } + }, + "nsdVersion": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Version of the onboarded network service descriptor in the network package.
" + } + }, + "nsdDesigner": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Designer of the onboarded network service descriptor in the network package.
" + } + }, + "nsdInvariantId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Identifies a network service descriptor in a version independent manner.
" + } + }, + "vnfPkgIds": { + "target": "com.amazonaws.tnb#VnfPkgIdList", + "traits": { + "smithy.api#documentation": "Identifies the function package for the function package descriptor referenced by the onboarded network package.
" + } + }, + "metadata": { + "target": "com.amazonaws.tnb#ListSolNetworkPackageMetadata", + "traits": { + "smithy.api#documentation": "The metadata of the network package.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Details of a network package.
\nA network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.
" + } + }, + "com.amazonaws.tnb#ListSolNetworkPackageMetadata": { + "type": "structure", + "members": { + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The date that the resource was created.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "lastModified": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The date that the resource was last modified.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + } + }, + "traits": { + "smithy.api#documentation": "Metadata related to a network package.
\nA network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.
" + } + }, + "com.amazonaws.tnb#ListSolNetworkPackageResources": { + "type": "list", + "member": { + "target": "com.amazonaws.tnb#ListSolNetworkPackageInfo" + } + }, + "com.amazonaws.tnb#ListSolNetworkPackages": { + "type": "operation", + "input": { + "target": "com.amazonaws.tnb#ListSolNetworkPackagesInput" + }, + "output": { + "target": "com.amazonaws.tnb#ListSolNetworkPackagesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.tnb#AccessDeniedException" + }, + { + "target": "com.amazonaws.tnb#InternalServerException" + }, + { + "target": "com.amazonaws.tnb#ThrottlingException" + }, + { + "target": "com.amazonaws.tnb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists network packages.
\nA network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.
", + "smithy.api#examples": [ + { + "title": "List information about multiple network packages without PaginationToken", + "input": { + "maxResults": 25, + "nextToken": "" + }, + "output": { + "nextToken": "ug2E9SheCpyAmeLItmHF99a8GNI6yAHxXIvgBkdiA2ixKvqdhYpNBLWHDl6vGnWt7Y4CB6m1Dkz86gSwcDouMO1pSrN%2BlGY2kbNtfTeMgnuB6bmwP/UU12r7MkHQyPCWMYG8OuCXkDBOYeX8qjRDTJ5vxAyrwtynaB6XDNDZA2DscCjcD7kpNzf3xlPRCwd6", + "networkPackages": [ + { + "id": "np-0d5b823eb5c2a9241", + "arn": "arn:aws:tnb:us-west-2:123456789000:network-package/np-0d5b823eb5c2a9241", + "nsdId": "be1abe66-1fcc-11ec-9621-0242ac130002", + "nsdName": "Sample-City", + "nsdVersion": "1.0", + "nsdDesigner": "Sample", + "nsdInvariantId": "SAMPLE_CITY", + "vnfPkgIds": [ + "fp-0b627c4a170a97f79", + "fp-09a2ba09fad0212cd" + ], + "nsdOnboardingState": "ONBOARDED", + "nsdOperationalState": "ENABLED", + "nsdUsageState": "IN_USE", + "metadata": { + "createdAt": "2022-06-10T19:48:34Z", + "lastModified": "2022-06-10T21:48:33Z" + } + }, + { + "id": "np-0d5b823eb5c2a9789", + "arn": "arn:aws:tnb:us-west-2:123456789000:network-package/np-0d5b823eb5c2a9789", + "nsdOnboardingState": "CREATED", + "nsdOperationalState": "DISABLED", + "nsdUsageState": "NOT_IN_USE", + "metadata": { + "createdAt": "2022-06-10T19:48:34Z", + "lastModified": "2022-06-10T21:48:33Z" + } + } + ] + } + }, + { + "title": "List information about multiple network packages with PaginationToken", + "input": { + "maxResults": 25, + "nextToken": "ug2E9SheCpyAmeLItmHF95t1rBBsFyzy5hsuauDTqaukll3AGHaTz%2B4utHS3OMuMcyKW6Hmk25aB6wtV%2BFxCx9Adw5fDSq9D8lVa6sr0Sq0BF7Fj0mYegd0a/XiFP4j/58ZIrtRl0M3Z55Z/wTqwIietXJVfFX84ZnIMjiEiFb3KIIdrKS8vSgMZ18t3Gj5p" + }, + "output": { + "nextToken": "ug2E9SheCpyAmeLItmHF93AYTN36C2xOijk0IW9FbkywwkM3QphGA%2BMbsKhEhOl3nacLxMMiBL9WOhOdo/ZCXfmS2/tHpzuWjvSODvivIJONDw3bUxYqjsT2w/lDWekKm9cRGhLaK6kCr1XBvm3USj/r6dBDL3gHYrwfmEGL7MRffCgc2IqYOL6O2Mhvbn89", + "networkPackages": [ + { + "id": "np-0d5b823eb5c2a9241", + "arn": "arn:aws:tnb:us-west-2:123456789000:network-package/np-0d5b823eb5c2a9241", + "nsdId": "be1abe66-1fcc-11ec-9621-0242ac130002", + "nsdName": "Sample-City", + "nsdVersion": "1.0", + "nsdDesigner": "Sample", + "nsdInvariantId": "SAMPLE_CITY", + "vnfPkgIds": [ + "fp-0b627c4a170a97f79", + "fp-09a2ba09fad0212cd" + ], + "nsdOnboardingState": "ONBOARDED", + "nsdOperationalState": "ENABLED", + "nsdUsageState": "IN_USE", + "metadata": { + "createdAt": "2022-06-10T19:48:34Z", + "lastModified": "2022-06-10T21:48:33Z" + } + } + ] + } + }, + { + "title": "No more network packages to return", + "input": {}, + "output": { + "networkPackages": [] + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/sol/nsd/v1/ns_descriptors" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "networkPackages" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.tnb#ListSolNetworkPackagesInput": { + "type": "structure", + "members": { + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of results to include in the response.
", + "smithy.api#httpQuery": "max_results", + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "nextToken": { + "target": "com.amazonaws.tnb#PaginationToken", + "traits": { + "smithy.api#documentation": "The token for the next page of results.
", + "smithy.api#httpQuery": "nextpage_opaque_marker" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.tnb#ListSolNetworkPackagesOutput": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.tnb#PaginationToken", + "traits": { + "smithy.api#documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Network packages. A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.tnb#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.tnb#ListTagsForResourceInput" + }, + "output": { + "target": "com.amazonaws.tnb#ListTagsForResourceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.tnb#AccessDeniedException" + }, + { + "target": "com.amazonaws.tnb#InternalServerException" + }, + { + "target": "com.amazonaws.tnb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.tnb#ThrottlingException" + }, + { + "target": "com.amazonaws.tnb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists tags for AWS TNB resources.
", + "smithy.api#http": { + "uri": "/tags/{resourceArn}", + "method": "GET" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.tnb#ListTagsForResourceInput": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.tnb#TNBResourceArn", + "traits": { + "smithy.api#documentation": "Resource ARN.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.tnb#ListTagsForResourceOutput": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.tnb#TagMap", + "traits": { + "smithy.api#documentation": "A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.tnb#NetworkArtifactMeta": { + "type": "structure", + "members": { + "overrides": { + "target": "com.amazonaws.tnb#OverrideList", + "traits": { + "smithy.api#documentation": "Lists network package overrides.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Metadata for network package artifacts.
\nArtifacts are the contents of the package descriptor file and the state of the package.
" + } + }, + "com.amazonaws.tnb#NsInstanceArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:(aws|aws-cn|aws-iso|aws-iso-b|aws-us-gov):tnb:([a-z]{2}(-(gov|isob|iso))?-(east|west|north|south|central){1,2}-[0-9]):\\d{12}:(network-instance/ni-[a-f0-9]{17})$" + } + }, + "com.amazonaws.tnb#NsInstanceId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^ni-[a-f0-9]{17}$" + } + }, + "com.amazonaws.tnb#NsLcmOpOccArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:(aws|aws-cn|aws-iso|aws-iso-b|aws-us-gov):tnb:([a-z]{2}(-(gov|isob|iso))?-(east|west|north|south|central){1,2}-[0-9]):\\d{12}:(network-operation/no-[a-f0-9]{17})$" + } + }, + "com.amazonaws.tnb#NsLcmOpOccId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^no-[a-f0-9]{17}$" + } + }, + "com.amazonaws.tnb#NsLcmOperationState": { + "type": "enum", + "members": { + "PROCESSING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROCESSING" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "CANCELLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCELLING" + } + }, + "CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCELLED" + } + } + } + }, + "com.amazonaws.tnb#NsState": { + "type": "enum", + "members": { + "INSTANTIATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSTANTIATED" + } + }, + "NOT_INSTANTIATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_INSTANTIATED" + } + }, + "IMPAIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMPAIRED" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPED" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + }, + "INSTANTIATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSTANTIATE_IN_PROGRESS" + } + }, + "UPDATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_IN_PROGRESS" + } + }, + "TERMINATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TERMINATE_IN_PROGRESS" + } + } + } + }, + "com.amazonaws.tnb#NsdId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" + } + }, + "com.amazonaws.tnb#NsdInfoArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:(aws|aws-cn|aws-iso|aws-iso-b|aws-us-gov):tnb:([a-z]{2}(-(gov|isob|iso))?-(east|west|north|south|central){1,2}-[0-9]):\\d{12}:(network-package/np-[a-f0-9]{17})$" + } + }, + "com.amazonaws.tnb#NsdInfoId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^np-[a-f0-9]{17}$" + } + }, + "com.amazonaws.tnb#NsdOnboardingState": { + "type": "enum", + "members": { + "CREATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATED" + } + }, + "ONBOARDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ONBOARDED" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR" + } + } + } + }, + "com.amazonaws.tnb#NsdOperationalState": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.tnb#NsdUsageState": { + "type": "enum", + "members": { + "IN_USE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_USE" + } + }, + "NOT_IN_USE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_IN_USE" + } + } + } + }, + "com.amazonaws.tnb#OnboardingState": { + "type": "enum", + "members": { + "CREATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATED" + } + }, + "ONBOARDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ONBOARDED" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR" + } + } + } + }, + "com.amazonaws.tnb#OperationalState": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.tnb#OverrideList": { + "type": "list", + "member": { + "target": "com.amazonaws.tnb#ToscaOverride" + } + }, + "com.amazonaws.tnb#PackageContentType": { + "type": "enum", + "members": { + "APPLICATION_ZIP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "application/zip" + } + } + } + }, + "com.amazonaws.tnb#PaginationToken": { + "type": "string" + }, + "com.amazonaws.tnb#ProblemDetails": { + "type": "structure", + "members": { + "detail": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A human-readable explanation specific to this occurrence of the problem.
", + "smithy.api#required": {} + } + }, + "title": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A human-readable title of the problem type.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details related to problems with AWS TNB resources.
" + } + }, + "com.amazonaws.tnb#PutSolFunctionPackageContent": { + "type": "operation", + "input": { + "target": "com.amazonaws.tnb#PutSolFunctionPackageContentInput" + }, + "output": { + "target": "com.amazonaws.tnb#PutSolFunctionPackageContentOutput" + }, + "errors": [ + { + "target": "com.amazonaws.tnb#AccessDeniedException" + }, + { + "target": "com.amazonaws.tnb#InternalServerException" + }, + { + "target": "com.amazonaws.tnb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.tnb#ThrottlingException" + }, + { + "target": "com.amazonaws.tnb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Uploads the contents of a function package.
\nA function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.
", + "smithy.api#examples": [ + { + "title": "Upload a function package content", + "input": { + "vnfPkgId": "fp-07aa863e53460a2a6", + "contentType": "application/zip", + "file": "UEsDBBQAAAAAAPqLiVMAAAAAAAAAAAAAAAAMACAAZnJlZTVnYy1hbWYvVVQNAAcIrrJhBK" + }, + "output": { + "id": "fp-07aa863e53460a2a6", + "vnfdId": "0d72acd9-e45d-4644-9bcd-1fe67cd0e2c8", + "vnfProductName": "Sample AMF", + "vnfProvider": "Sample", + "vnfdVersion": "1.0.0", + "metadata": { + "vnfd": { + "overrides": [] + } + } + } + } + ], + "smithy.api#http": { + "method": "PUT", + "uri": "/sol/vnfpkgm/v1/vnf_packages/{vnfPkgId}/package_content", + "code": 202 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.tnb#PutSolFunctionPackageContentInput": { + "type": "structure", + "members": { + "vnfPkgId": { + "target": "com.amazonaws.tnb#VnfPkgId", + "traits": { + "smithy.api#documentation": "Function package ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "contentType": { + "target": "com.amazonaws.tnb#PackageContentType", + "traits": { + "smithy.api#documentation": "Function package content type.
", + "smithy.api#httpHeader": "Content-Type" + } + }, + "file": { + "target": "smithy.api#Blob", + "traits": { + "smithy.api#documentation": "Function package file.
", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.tnb#PutSolFunctionPackageContentMetadata": { + "type": "structure", + "members": { + "vnfd": { + "target": "com.amazonaws.tnb#FunctionArtifactMeta" + } + }, + "traits": { + "smithy.api#documentation": "Update metadata in a function package.
\nA function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.
" + } + }, + "com.amazonaws.tnb#PutSolFunctionPackageContentOutput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.tnb#VnfPkgId", + "traits": { + "smithy.api#documentation": "Function package ID.
", + "smithy.api#required": {} + } + }, + "vnfdId": { + "target": "com.amazonaws.tnb#VnfdId", + "traits": { + "smithy.api#documentation": "Function package descriptor ID.
", + "smithy.api#required": {} + } + }, + "vnfProductName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Function product name.
", + "smithy.api#required": {} + } + }, + "vnfProvider": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Function provider.
", + "smithy.api#required": {} + } + }, + "vnfdVersion": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Function package descriptor version.
", + "smithy.api#required": {} + } + }, + "metadata": { + "target": "com.amazonaws.tnb#PutSolFunctionPackageContentMetadata", + "traits": { + "smithy.api#documentation": "Function package metadata.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.tnb#PutSolNetworkPackageContent": { + "type": "operation", + "input": { + "target": "com.amazonaws.tnb#PutSolNetworkPackageContentInput" + }, + "output": { + "target": "com.amazonaws.tnb#PutSolNetworkPackageContentOutput" + }, + "errors": [ + { + "target": "com.amazonaws.tnb#AccessDeniedException" + }, + { + "target": "com.amazonaws.tnb#InternalServerException" + }, + { + "target": "com.amazonaws.tnb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.tnb#ThrottlingException" + }, + { + "target": "com.amazonaws.tnb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Uploads the contents of a network package.
\nA network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.
", + "smithy.api#examples": [ + { + "title": "Upload the network package content of an NSD archive", + "input": { + "nsdInfoId": "np-0d5b823eb5c2a9241", + "contentType": "application/zip", + "file": "UEsDBBQAAAAAAPqLiVMAAAAAAAAAAAAAA" + }, + "output": { + "id": "np-0d5b823eb5c2a9241", + "arn": "arn:aws:tnb:us-west-2:123456789000:network-package/np-0d5b823eb5c2a9241", + "nsdId": "0d72acd9-e45d-4644-9bcd-1fe67cd0e2c8", + "nsdName": "Sample Single Cluster", + "nsdVersion": "1.0.0", + "vnfPkgIds": [ + "fp-1234567890abcdabc", + "fp-0b627c4a170a97f79" + ], + "metadata": { + "nsd": { + "overrides": [ + { + "name": "cidr_block", + "defaultValue": "10.0.0.0/24" + }, + { + "name": "some_vnf.vnf_prop" + } + ] + } + } + } + } + ], + "smithy.api#http": { + "method": "PUT", + "uri": "/sol/nsd/v1/ns_descriptors/{nsdInfoId}/nsd_content", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.tnb#PutSolNetworkPackageContentInput": { + "type": "structure", + "members": { + "nsdInfoId": { + "target": "com.amazonaws.tnb#NsdInfoId", + "traits": { + "smithy.api#documentation": "Network service descriptor info ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "contentType": { + "target": "com.amazonaws.tnb#PackageContentType", + "traits": { + "smithy.api#documentation": "Network package content type.
", + "smithy.api#httpHeader": "Content-Type" + } + }, + "file": { + "target": "smithy.api#Blob", + "traits": { + "smithy.api#documentation": "Network package file.
", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.tnb#PutSolNetworkPackageContentMetadata": { + "type": "structure", + "members": { + "nsd": { + "target": "com.amazonaws.tnb#NetworkArtifactMeta" + } + }, + "traits": { + "smithy.api#documentation": "Update metadata in a network package.
\nA network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.
" + } + }, + "com.amazonaws.tnb#PutSolNetworkPackageContentOutput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.tnb#NsdInfoId", + "traits": { + "smithy.api#documentation": "Network package ID.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.tnb#NsdInfoArn", + "traits": { + "smithy.api#documentation": "Network package ARN.
", + "smithy.api#required": {} + } + }, + "nsdId": { + "target": "com.amazonaws.tnb#NsdId", + "traits": { + "smithy.api#documentation": "Network service descriptor ID.
", + "smithy.api#required": {} + } + }, + "nsdName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Network service descriptor name.
", + "smithy.api#required": {} + } + }, + "nsdVersion": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Network service descriptor version.
", + "smithy.api#required": {} + } + }, + "vnfPkgIds": { + "target": "com.amazonaws.tnb#VnfPkgIdList", + "traits": { + "smithy.api#documentation": "Function package IDs.
", + "smithy.api#required": {} + } + }, + "metadata": { + "target": "com.amazonaws.tnb#PutSolNetworkPackageContentMetadata", + "traits": { + "smithy.api#documentation": "Network package metadata.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.tnb#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Request references a resource that doesn't exist.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.tnb#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Service quotas have been exceeded.
", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.tnb#StringMap": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.tnb#TNB": { + "type": "service", + "version": "2008-10-21", + "operations": [ + { + "target": "com.amazonaws.tnb#CancelSolNetworkOperation" + }, + { + "target": "com.amazonaws.tnb#CreateSolFunctionPackage" + }, + { + "target": "com.amazonaws.tnb#CreateSolNetworkInstance" + }, + { + "target": "com.amazonaws.tnb#CreateSolNetworkPackage" + }, + { + "target": "com.amazonaws.tnb#DeleteSolFunctionPackage" + }, + { + "target": "com.amazonaws.tnb#DeleteSolNetworkInstance" + }, + { + "target": "com.amazonaws.tnb#DeleteSolNetworkPackage" + }, + { + "target": "com.amazonaws.tnb#GetSolFunctionInstance" + }, + { + "target": "com.amazonaws.tnb#GetSolFunctionPackage" + }, + { + "target": "com.amazonaws.tnb#GetSolFunctionPackageContent" + }, + { + "target": "com.amazonaws.tnb#GetSolFunctionPackageDescriptor" + }, + { + "target": "com.amazonaws.tnb#GetSolNetworkInstance" + }, + { + "target": "com.amazonaws.tnb#GetSolNetworkOperation" + }, + { + "target": "com.amazonaws.tnb#GetSolNetworkPackage" + }, + { + "target": "com.amazonaws.tnb#GetSolNetworkPackageContent" + }, + { + "target": "com.amazonaws.tnb#GetSolNetworkPackageDescriptor" + }, + { + "target": "com.amazonaws.tnb#InstantiateSolNetworkInstance" + }, + { + "target": "com.amazonaws.tnb#ListSolFunctionInstances" + }, + { + "target": "com.amazonaws.tnb#ListSolFunctionPackages" + }, + { + "target": "com.amazonaws.tnb#ListSolNetworkInstances" + }, + { + "target": "com.amazonaws.tnb#ListSolNetworkOperations" + }, + { + "target": "com.amazonaws.tnb#ListSolNetworkPackages" + }, + { + "target": "com.amazonaws.tnb#ListTagsForResource" + }, + { + "target": "com.amazonaws.tnb#PutSolFunctionPackageContent" + }, + { + "target": "com.amazonaws.tnb#PutSolNetworkPackageContent" + }, + { + "target": "com.amazonaws.tnb#TagResource" + }, + { + "target": "com.amazonaws.tnb#TerminateSolNetworkInstance" + }, + { + "target": "com.amazonaws.tnb#UntagResource" + }, + { + "target": "com.amazonaws.tnb#UpdateSolFunctionPackage" + }, + { + "target": "com.amazonaws.tnb#UpdateSolNetworkInstance" + }, + { + "target": "com.amazonaws.tnb#UpdateSolNetworkPackage" + }, + { + "target": "com.amazonaws.tnb#ValidateSolFunctionPackageContent" + }, + { + "target": "com.amazonaws.tnb#ValidateSolNetworkPackageContent" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "tnb", + "apiVersion": "v1", + "arnNamespace": "tnb" + }, + "aws.auth#sigv4": { + "name": "tnb" + }, + "aws.protocols#restJson1": {}, + "smithy.api#cors": { + "additionalAllowedHeaders": [ + "*", + "content-type", + "x-amz-content-sha256", + "x-amz-user-agent", + "x-amzn-platform-id", + "x-amzn-trace-id" + ], + "additionalExposedHeaders": [ + "x-amzn-errortype", + "x-amzn-requestid", + "x-amzn-trace-id" + ], + "maxAge": 86400 + }, + "smithy.api#documentation": "Amazon Web Services Telco Network Builder (TNB) is a network automation service that helps you deploy and manage telecom networks. AWS TNB helps you with the lifecycle management of your telecommunication network functions throughout planning, deployment, and post-deployment activities.
", + "smithy.api#title": "AWS Telco Network Builder", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "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" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://tnb-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://tnb-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://tnb.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://tnb.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + } + ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://tnb-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-gov-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://tnb-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-gov-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://tnb.us-gov-east-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-gov-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://tnb.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-gov-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://tnb-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseFIPS": true, + "Region": "cn-north-1", + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://tnb-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseFIPS": true, + "Region": "cn-north-1", + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://tnb.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseFIPS": false, + "Region": "cn-north-1", + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://tnb.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseFIPS": false, + "Region": "cn-north-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "UseFIPS": true, + "Region": "us-iso-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://tnb-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-iso-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "UseFIPS": false, + "Region": "us-iso-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://tnb.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-iso-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://tnb-fips.us-east-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://tnb-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://tnb.us-east-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://tnb.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "UseFIPS": true, + "Region": "us-isob-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://tnb-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-isob-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "UseFIPS": false, + "Region": "us-isob-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://tnb.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-isob-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "UseFIPS": true, + "Region": "us-east-1", + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": true, + "Endpoint": "https://example.com" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.tnb#TNBResourceArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws:tnb:[a-z0-9-]+:[^:]*:.*$" + } + }, + "com.amazonaws.tnb#TagKey": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(?!aws:).{1,128}$" + } + }, + "com.amazonaws.tnb#TagKeys": { + "type": "list", + "member": { + "target": "com.amazonaws.tnb#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.tnb#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.tnb#TagKey" + }, + "value": { + "target": "com.amazonaws.tnb#TagValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.tnb#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.tnb#TagResourceInput" + }, + "output": { + "target": "com.amazonaws.tnb#TagResourceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.tnb#AccessDeniedException" + }, + { + "target": "com.amazonaws.tnb#InternalServerException" + }, + { + "target": "com.amazonaws.tnb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.tnb#ThrottlingException" + }, + { + "target": "com.amazonaws.tnb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Tags an AWS TNB resource.
\nA tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.
", + "smithy.api#http": { + "uri": "/tags/{resourceArn}", + "method": "POST" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.tnb#TagResourceInput": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.tnb#TNBResourceArn", + "traits": { + "smithy.api#documentation": "Resource ARN.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.tnb#TagMap", + "traits": { + "smithy.api#documentation": "A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.tnb#TagResourceOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.tnb#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.tnb#TaskStatus": { + "type": "enum", + "members": { + "SCHEDULED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCHEDULED" + } + }, + "STARTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARTED" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR" + } + }, + "SKIPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SKIPPED" + } + }, + "CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCELLED" + } + } + } + }, + "com.amazonaws.tnb#TerminateSolNetworkInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.tnb#TerminateSolNetworkInstanceInput" + }, + "output": { + "target": "com.amazonaws.tnb#TerminateSolNetworkInstanceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.tnb#AccessDeniedException" + }, + { + "target": "com.amazonaws.tnb#InternalServerException" + }, + { + "target": "com.amazonaws.tnb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.tnb#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.tnb#ThrottlingException" + }, + { + "target": "com.amazonaws.tnb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Terminates a network instance.
\nA network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.
\nYou must terminate a network instance before you can delete it.
", + "smithy.api#examples": [ + { + "title": "Terminate a Sol Network Instance", + "input": { + "nsInstanceId": "ni-0d5b823eb5c2a9241" + }, + "output": { + "nsLcmOpOccId": "no-0d5b823eb5c2a9241" + } + } + ], + "smithy.api#http": { + "method": "POST", + "uri": "/sol/nslcm/v1/ns_instances/{nsInstanceId}/terminate", + "code": 201 + } + } + }, + "com.amazonaws.tnb#TerminateSolNetworkInstanceInput": { + "type": "structure", + "members": { + "nsInstanceId": { + "target": "com.amazonaws.tnb#NsInstanceId", + "traits": { + "smithy.api#documentation": "ID of the network instance.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.tnb#TerminateSolNetworkInstanceOutput": { + "type": "structure", + "members": { + "nsLcmOpOccId": { + "target": "com.amazonaws.tnb#NsLcmOpOccId", + "traits": { + "smithy.api#documentation": "The identifier of the operation occurrence.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.tnb#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Exception caused by throttling.
", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.tnb#ToscaOverride": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Name of the TOSCA override.
" + } + }, + "defaultValue": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Default value for the override.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Overrides of the TOSCA node.
" + } + }, + "com.amazonaws.tnb#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.tnb#UntagResourceInput" + }, + "output": { + "target": "com.amazonaws.tnb#UntagResourceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.tnb#AccessDeniedException" + }, + { + "target": "com.amazonaws.tnb#InternalServerException" + }, + { + "target": "com.amazonaws.tnb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.tnb#ThrottlingException" + }, + { + "target": "com.amazonaws.tnb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Untags an AWS TNB resource.
\nA tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.
", + "smithy.api#http": { + "uri": "/tags/{resourceArn}", + "method": "DELETE" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.tnb#UntagResourceInput": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.tnb#TNBResourceArn", + "traits": { + "smithy.api#documentation": "Resource ARN.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tagKeys": { + "target": "com.amazonaws.tnb#TagKeys", + "traits": { + "smithy.api#documentation": "Tag keys.
", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.tnb#UntagResourceOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.tnb#UpdateSolFunctionPackage": { + "type": "operation", + "input": { + "target": "com.amazonaws.tnb#UpdateSolFunctionPackageInput" + }, + "output": { + "target": "com.amazonaws.tnb#UpdateSolFunctionPackageOutput" + }, + "errors": [ + { + "target": "com.amazonaws.tnb#AccessDeniedException" + }, + { + "target": "com.amazonaws.tnb#InternalServerException" + }, + { + "target": "com.amazonaws.tnb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.tnb#ThrottlingException" + }, + { + "target": "com.amazonaws.tnb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the operational state of function package.
\nA function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.
", + "smithy.api#examples": [ + { + "title": "Enable a function package's Operational State", + "input": { + "vnfPkgId": "fp-07aa863e53460a2a6", + "operationalState": "ENABLED" + }, + "output": { + "operationalState": "ENABLED" + } + }, + { + "title": "Disable a function package's Operational State", + "input": { + "vnfPkgId": "fp-07aa863e53460a2a6", + "operationalState": "DISABLED" + }, + "output": { + "operationalState": "DISABLED" + } + } + ], + "smithy.api#http": { + "method": "PATCH", + "uri": "/sol/vnfpkgm/v1/vnf_packages/{vnfPkgId}" + } + } + }, + "com.amazonaws.tnb#UpdateSolFunctionPackageInput": { + "type": "structure", + "members": { + "vnfPkgId": { + "target": "com.amazonaws.tnb#VnfPkgId", + "traits": { + "smithy.api#documentation": "ID of the function package.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "operationalState": { + "target": "com.amazonaws.tnb#OperationalState", + "traits": { + "smithy.api#documentation": "Operational state of the function package.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.tnb#UpdateSolFunctionPackageOutput": { + "type": "structure", + "members": { + "operationalState": { + "target": "com.amazonaws.tnb#OperationalState", + "traits": { + "smithy.api#documentation": "Operational state of the function package.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.tnb#UpdateSolNetworkInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.tnb#UpdateSolNetworkInstanceInput" + }, + "output": { + "target": "com.amazonaws.tnb#UpdateSolNetworkInstanceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.tnb#AccessDeniedException" + }, + { + "target": "com.amazonaws.tnb#InternalServerException" + }, + { + "target": "com.amazonaws.tnb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.tnb#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.tnb#ThrottlingException" + }, + { + "target": "com.amazonaws.tnb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Update a network instance.
\nA network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.
", + "smithy.api#examples": [ + { + "title": "Update a Sol Network Instance", + "input": { + "nsInstanceId": "ni-0d5b823eb5c2a9241", + "updateType": "MODIFY_VNF_INFORMATION", + "modifyVnfInfoData": { + "vnfInstanceId": "fi-0d5b823eb5c2a9241", + "vnfConfigurableProperties": { + "pcf.port": "8080", + "pcf.pods": "10" + } + } + }, + "output": { + "nsLcmOpOccId": "no-0d5b823eb5c2a9241" + } + } + ], + "smithy.api#http": { + "method": "POST", + "uri": "/sol/nslcm/v1/ns_instances/{nsInstanceId}/update", + "code": 201 + } + } + }, + "com.amazonaws.tnb#UpdateSolNetworkInstanceInput": { + "type": "structure", + "members": { + "nsInstanceId": { + "target": "com.amazonaws.tnb#NsInstanceId", + "traits": { + "smithy.api#documentation": "ID of the network instance.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "updateType": { + "target": "com.amazonaws.tnb#UpdateSolNetworkType", + "traits": { + "smithy.api#documentation": "The type of update.
", + "smithy.api#required": {} + } + }, + "modifyVnfInfoData": { + "target": "com.amazonaws.tnb#UpdateSolNetworkModify", + "traits": { + "smithy.api#documentation": "Identifies the network function information parameters and/or the configurable properties of the network function to be modified.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.tnb#UpdateSolNetworkInstanceOutput": { + "type": "structure", + "members": { + "nsLcmOpOccId": { + "target": "com.amazonaws.tnb#NsLcmOpOccId", + "traits": { + "smithy.api#documentation": "The identifier of the network instance operation occurrence.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.tnb#UpdateSolNetworkModify": { + "type": "structure", + "members": { + "vnfInstanceId": { + "target": "com.amazonaws.tnb#VnfInstanceId", + "traits": { + "smithy.api#documentation": "ID of the network function instance.
\nA network function instance is a function in a function package .
", + "smithy.api#required": {} + } + }, + "vnfConfigurableProperties": { + "target": "smithy.api#Document", + "traits": { + "smithy.api#documentation": "Provides values for the configurable properties declared in the function package descriptor.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Information parameters and/or the configurable properties for a network function.
\nA network function instance is a function in a function package .
" + } + }, + "com.amazonaws.tnb#UpdateSolNetworkPackage": { + "type": "operation", + "input": { + "target": "com.amazonaws.tnb#UpdateSolNetworkPackageInput" + }, + "output": { + "target": "com.amazonaws.tnb#UpdateSolNetworkPackageOutput" + }, + "errors": [ + { + "target": "com.amazonaws.tnb#AccessDeniedException" + }, + { + "target": "com.amazonaws.tnb#InternalServerException" + }, + { + "target": "com.amazonaws.tnb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.tnb#ThrottlingException" + }, + { + "target": "com.amazonaws.tnb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the operational state of a network package.
\nA network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.
\nA network service descriptor is a .yaml file in a network package that uses the TOSCA standard to describe the network functions you want to deploy and the Amazon Web Services infrastructure you want to deploy the network functions on.
", + "smithy.api#examples": [ + { + "title": "Enable a network package's Operational State", + "input": { + "nsdInfoId": "np-0d5b823eb5c2a9241", + "nsdOperationalState": "ENABLED" + }, + "output": { + "nsdOperationalState": "ENABLED" + } + }, + { + "title": "Disable a network package's Operational State", + "input": { + "nsdInfoId": "np-0d5b823eb5c2a9241", + "nsdOperationalState": "DISABLED" + }, + "output": { + "nsdOperationalState": "DISABLED" + } + } + ], + "smithy.api#http": { + "method": "PATCH", + "uri": "/sol/nsd/v1/ns_descriptors/{nsdInfoId}" + } + } + }, + "com.amazonaws.tnb#UpdateSolNetworkPackageInput": { + "type": "structure", + "members": { + "nsdInfoId": { + "target": "com.amazonaws.tnb#NsdInfoId", + "traits": { + "smithy.api#documentation": "ID of the network service descriptor in the network package.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nsdOperationalState": { + "target": "com.amazonaws.tnb#NsdOperationalState", + "traits": { + "smithy.api#documentation": "Operational state of the network service descriptor in the network package.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.tnb#UpdateSolNetworkPackageOutput": { + "type": "structure", + "members": { + "nsdOperationalState": { + "target": "com.amazonaws.tnb#NsdOperationalState", + "traits": { + "smithy.api#documentation": "Operational state of the network service descriptor in the network package.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.tnb#UpdateSolNetworkType": { + "type": "enum", + "members": { + "MODIFY_VNF_INFORMATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MODIFY_VNF_INFORMATION" + } + } + } + }, + "com.amazonaws.tnb#UsageState": { + "type": "enum", + "members": { + "IN_USE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_USE" + } + }, + "NOT_IN_USE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_IN_USE" + } + } + } + }, + "com.amazonaws.tnb#ValidateSolFunctionPackageContent": { + "type": "operation", + "input": { + "target": "com.amazonaws.tnb#ValidateSolFunctionPackageContentInput" + }, + "output": { + "target": "com.amazonaws.tnb#ValidateSolFunctionPackageContentOutput" + }, + "errors": [ + { + "target": "com.amazonaws.tnb#AccessDeniedException" + }, + { + "target": "com.amazonaws.tnb#InternalServerException" + }, + { + "target": "com.amazonaws.tnb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.tnb#ThrottlingException" + }, + { + "target": "com.amazonaws.tnb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Validates function package content. This can be used as a dry run before uploading function package content with PutSolFunctionPackageContent.
\nA function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.
", + "smithy.api#examples": [ + { + "title": "Validate a Function Package content", + "input": { + "vnfPkgId": "fp-07aa863e53460a2a6", + "contentType": "application/zip", + "file": "UEsDBBQAAAAAAPqLiVMAAAAAAAAAAAAAAAAMACAAZnJlZTVnYy1hbWYvVVQNAAcIrrJhBK" + }, + "output": { + "id": "fp-07aa863e53460a2a6", + "vnfdId": "0d72acd9-e45d-4644-9bcd-1fe67cd0e2c8", + "vnfProductName": "Sample AMF", + "vnfProvider": "Sample", + "vnfdVersion": "1.0.0", + "metadata": { + "vnfd": { + "overrides": [] + } + } + } + } + ], + "smithy.api#http": { + "method": "PUT", + "uri": "/sol/vnfpkgm/v1/vnf_packages/{vnfPkgId}/package_content/validate", + "code": 202 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.tnb#ValidateSolFunctionPackageContentInput": { + "type": "structure", + "members": { + "vnfPkgId": { + "target": "com.amazonaws.tnb#VnfPkgId", + "traits": { + "smithy.api#documentation": "Function package ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "contentType": { + "target": "com.amazonaws.tnb#PackageContentType", + "traits": { + "smithy.api#documentation": "Function package content type.
", + "smithy.api#httpHeader": "Content-Type" + } + }, + "file": { + "target": "smithy.api#Blob", + "traits": { + "smithy.api#documentation": "Function package file.
", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.tnb#ValidateSolFunctionPackageContentMetadata": { + "type": "structure", + "members": { + "vnfd": { + "target": "com.amazonaws.tnb#FunctionArtifactMeta" + } + }, + "traits": { + "smithy.api#documentation": "Validates function package content metadata.
\nA function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.
" + } + }, + "com.amazonaws.tnb#ValidateSolFunctionPackageContentOutput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.tnb#VnfPkgId", + "traits": { + "smithy.api#documentation": "Function package ID.
", + "smithy.api#required": {} + } + }, + "vnfdId": { + "target": "com.amazonaws.tnb#VnfdId", + "traits": { + "smithy.api#documentation": "Function package descriptor ID.
", + "smithy.api#required": {} + } + }, + "vnfProductName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Network function product name.
", + "smithy.api#required": {} + } + }, + "vnfProvider": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Network function provider.
", + "smithy.api#required": {} + } + }, + "vnfdVersion": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Function package descriptor version.
", + "smithy.api#required": {} + } + }, + "metadata": { + "target": "com.amazonaws.tnb#ValidateSolFunctionPackageContentMetadata", + "traits": { + "smithy.api#documentation": "Function package metadata.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.tnb#ValidateSolNetworkPackageContent": { + "type": "operation", + "input": { + "target": "com.amazonaws.tnb#ValidateSolNetworkPackageContentInput" + }, + "output": { + "target": "com.amazonaws.tnb#ValidateSolNetworkPackageContentOutput" + }, + "errors": [ + { + "target": "com.amazonaws.tnb#AccessDeniedException" + }, + { + "target": "com.amazonaws.tnb#InternalServerException" + }, + { + "target": "com.amazonaws.tnb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.tnb#ThrottlingException" + }, + { + "target": "com.amazonaws.tnb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Validates network package content. This can be used as a dry run before uploading network package content with PutSolNetworkPackageContent.
\nA network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.
", + "smithy.api#examples": [ + { + "title": "Validate the network package content of a NSD archive", + "input": { + "nsdInfoId": "np-0d5b823eb5c2a9241", + "contentType": "application/zip", + "file": "UEsDBBQAAAAAAPqLiVMAAAAAAAAAAAAAA" + }, + "output": { + "id": "np-0d5b823eb5c2a9241", + "arn": "arn:aws:tnb:us-west-2:123456789000:network-package/np-0d5b823eb5c2a9241", + "nsdId": "0d72acd9-e45d-4644-9bcd-1fe67cd0e2c8", + "nsdName": "Sample Single Cluster", + "nsdVersion": "1.0.0", + "vnfPkgIds": [ + "fp-1234567890abcdabc", + "fp-0b627c4a170a97f79" + ], + "metadata": { + "nsd": { + "overrides": [ + { + "name": "cidr_block", + "defaultValue": "10.0.0.0/24" + }, + { + "name": "some_vnf.vnf_prop" + } + ] + } + } + } + } + ], + "smithy.api#http": { + "method": "PUT", + "uri": "/sol/nsd/v1/ns_descriptors/{nsdInfoId}/nsd_content/validate", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.tnb#ValidateSolNetworkPackageContentInput": { + "type": "structure", + "members": { + "nsdInfoId": { + "target": "com.amazonaws.tnb#NsdInfoId", + "traits": { + "smithy.api#documentation": "Network service descriptor file.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "contentType": { + "target": "com.amazonaws.tnb#PackageContentType", + "traits": { + "smithy.api#documentation": "Network package content type.
", + "smithy.api#httpHeader": "Content-Type" + } + }, + "file": { + "target": "smithy.api#Blob", + "traits": { + "smithy.api#documentation": "Network package file.
", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.tnb#ValidateSolNetworkPackageContentMetadata": { + "type": "structure", + "members": { + "nsd": { + "target": "com.amazonaws.tnb#NetworkArtifactMeta" + } + }, + "traits": { + "smithy.api#documentation": "Validates network package content metadata.
\nA network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.
" + } + }, + "com.amazonaws.tnb#ValidateSolNetworkPackageContentOutput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.tnb#NsdInfoId", + "traits": { + "smithy.api#documentation": "Network package ID.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.tnb#NsdInfoArn", + "traits": { + "smithy.api#documentation": "Network package ARN.
", + "smithy.api#required": {} + } + }, + "nsdId": { + "target": "com.amazonaws.tnb#NsdId", + "traits": { + "smithy.api#documentation": "Network service descriptor ID.
", + "smithy.api#required": {} + } + }, + "nsdName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Network service descriptor name.
", + "smithy.api#required": {} + } + }, + "nsdVersion": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Network service descriptor version.
", + "smithy.api#required": {} + } + }, + "vnfPkgIds": { + "target": "com.amazonaws.tnb#VnfPkgIdList", + "traits": { + "smithy.api#documentation": "Function package IDs.
", + "smithy.api#required": {} + } + }, + "metadata": { + "target": "com.amazonaws.tnb#ValidateSolNetworkPackageContentMetadata", + "traits": { + "smithy.api#documentation": "Network package metadata.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.tnb#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Unable to process the request because the client provided input failed to satisfy request constraints.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.tnb#VnfInstanceArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:(aws|aws-cn|aws-iso|aws-iso-b|aws-us-gov):tnb:([a-z]{2}(-(gov|isob|iso))?-(east|west|north|south|central){1,2}-[0-9]):\\d{12}:(function-instance/fi-[a-f0-9]{17})$" + } + }, + "com.amazonaws.tnb#VnfInstanceId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^fi-[a-f0-9]{17}$" + } + }, + "com.amazonaws.tnb#VnfInstantiationState": { + "type": "enum", + "members": { + "INSTANTIATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSTANTIATED" + } + }, + "NOT_INSTANTIATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_INSTANTIATED" + } + } + } + }, + "com.amazonaws.tnb#VnfOperationalState": { + "type": "enum", + "members": { + "STARTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARTED" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPED" + } + } + } + }, + "com.amazonaws.tnb#VnfPkgArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:(aws|aws-cn|aws-iso|aws-iso-b|aws-us-gov):tnb:([a-z]{2}(-(gov|isob|iso))?-(east|west|north|south|central){1,2}-[0-9]):\\d{12}:(function-package/fp-[a-f0-9]{17})$" + } + }, + "com.amazonaws.tnb#VnfPkgId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^fp-[a-f0-9]{17}$" + } + }, + "com.amazonaws.tnb#VnfPkgIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.tnb#VnfPkgId" + } + }, + "com.amazonaws.tnb#VnfdId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" + } + } + } +} \ No newline at end of file