Contains APIs related to model invocation and querying of knowledge bases.
", "operations": { - "InvokeAgent": "Sends a prompt for the agent to process and respond to. Use return control event type for function calling.
The CLI doesn't support InvokeAgent.
To continue the same conversation with an agent, use the same sessionId value in the request.
To activate trace enablement, turn enableTrace to true. Trace enablement helps you follow the agent's reasoning process that led it to the information it processed, the actions it took, and the final result it yielded. For more information, see Trace enablement.
End a conversation by setting endSession to true.
In the sessionState object, you can include attributes for the session or prompt or parameters returned from the action group.
Use return control event type for function calling.
The response is returned in the bytes field of the chunk object.
The attribution object contains citations for parts of the response.
If you set enableTrace to true in the request, you can trace the agent's steps and reasoning process that led it to the response.
Errors are also surfaced in the response.
The CLI doesn't support InvokeAgent.
Sends a prompt for the agent to process and respond to. Note the following fields for the request:
To continue the same conversation with an agent, use the same sessionId value in the request.
To activate trace enablement, turn enableTrace to true. Trace enablement helps you follow the agent's reasoning process that led it to the information it processed, the actions it took, and the final result it yielded. For more information, see Trace enablement.
End a conversation by setting endSession to true.
In the sessionState object, you can include attributes for the session or prompt or, if you configured an action group to return control, results from invocation of the action group.
The response is returned in the bytes field of the chunk object.
The attribution object contains citations for parts of the response.
If you set enableTrace to true in the request, you can trace the agent's steps and reasoning process that led it to the response.
If the action predicted was configured to return control, the response returns parameters for the action, elicited from the user, in the returnControl field.
Errors are also surfaced in the response.
Queries a knowledge base and retrieves information from it.
", "RetrieveAndGenerate": "Queries a knowledge base and generates responses based on the retrieved results. The response only cites sources that are relevant to the query.
" }, @@ -37,6 +37,25 @@ "ActionGroupInvocationOutput$text": "The JSON-formatted string returned by the API invoked by the action group.
" } }, + "AdditionalModelRequestFields": { + "base": null, + "refs": { + "ExternalSourcesGenerationConfiguration$additionalModelRequestFields": "Additional model parameters and their corresponding values not included in the textInferenceConfig structure for an external source. Takes in custom model parameters specific to the language model being used.
", + "GenerationConfiguration$additionalModelRequestFields": "Additional model parameters and corresponding values not included in the textInferenceConfig structure for a knowledge base. This allows users to provide custom model parameters specific to the language model being used.
" + } + }, + "AdditionalModelRequestFieldsKey": { + "base": null, + "refs": { + "AdditionalModelRequestFields$key": null + } + }, + "AdditionalModelRequestFieldsValue": { + "base": null, + "refs": { + "AdditionalModelRequestFields$value": null + } + }, "AgentAliasId": { "base": null, "refs": { @@ -64,13 +83,13 @@ } }, "ApiInvocationInput": { - "base": "Contains information about the API operation that the agent predicts should be called.
This data type is used in the following API operations:
In the returnControl field of the Retrieve response
Contains information about the API operation that the agent predicts should be called.
This data type is used in the following API operations:
In the returnControl field of the InvokeAgent response
Contains information about the API operation that the agent predicts should be called.
" } }, "ApiParameter": { - "base": "Information about a parameter to provide to the API request.
This data type is used in the following API operations:
", + "base": "Information about a parameter to provide to the API request.
This data type is used in the following API operations:
", "refs": { "ApiParameters$member": null } @@ -90,13 +109,13 @@ } }, "ApiRequestBody": { - "base": "The request body to provide for the API request, as the agent elicited from the user.
This data type is used in the following API operations:
", + "base": "The request body to provide for the API request, as the agent elicited from the user.
This data type is used in the following API operations:
", "refs": { "ApiInvocationInput$requestBody": "The request body to provide for the API request, as the agent elicited from the user.
" } }, "ApiResult": { - "base": "Contains information about the API operation that was called from the action group and the response body that was returned.
This data type is used in the following API operations:
In the returnControlInvocationResults of the Retrieve request
Contains information about the API operation that was called from the action group and the response body that was returned.
This data type is used in the following API operations:
In the returnControlInvocationResults of the InvokeAgent request
The result from the API response from the action group invocation.
" } @@ -141,7 +160,7 @@ } }, "Citation": { - "base": "An object containing a segment of the generated response that is based on a source in the knowledge base, alongside information about the source.
This data type is used in the following API operations:
Retrieve response – in the citations field
RetrieveAndGenerate response – in the citations field
An object containing a segment of the generated response that is based on a source in the knowledge base, alongside information about the source.
This data type is used in the following API operations:
InvokeAgent response – in the citations field
RetrieveAndGenerate response – in the citations field
Contains the body of the API response.
This data type is used in the following API operations:
In the returnControlInvocationResults field of the Retrieve request
Contains the body of the API response.
This data type is used in the following API operations:
In the returnControlInvocationResults field of the InvokeAgent request
Contains information about the function that the agent predicts should be called.
This data type is used in the following API operations:
In the returnControl field of the Retrieve response
Contains information about the function that the agent predicts should be called.
This data type is used in the following API operations:
In the returnControl field of the InvokeAgent response
Contains information about the function that the agent predicts should be called.
" } }, "FunctionParameter": { - "base": "Contains information about a parameter of the function.
This data type is used in the following API operations:
In the returnControl field of the Retrieve response
Contains information about a parameter of the function.
This data type is used in the following API operations:
In the returnControl field of the InvokeAgent response
Contains information about the function that was called from the action group and the response that was returned.
This data type is used in the following API operations:
In the returnControlInvocationResults of the Retrieve request
Contains information about the function that was called from the action group and the response that was returned.
This data type is used in the following API operations:
In the returnControlInvocationResults of the InvokeAgent request
The result from the function from the action group invocation.
" } }, "GeneratedResponsePart": { - "base": "Contains metadata about a part of the generated response that is accompanied by a citation.
This data type is used in the following API operations:
Retrieve response – in the generatedResponsePart field
RetrieveAndGenerate response – in the generatedResponsePart field
Contains metadata about a part of the generated response that is accompanied by a citation.
This data type is used in the following API operations:
InvokeAgent response – in the generatedResponsePart field
RetrieveAndGenerate response – in the generatedResponsePart field
Contains the generated response and metadata
" } @@ -318,12 +337,44 @@ "KnowledgeBaseRetrieveAndGenerateConfiguration$generationConfiguration": "Contains configurations for response generation based on the knowwledge base query results.
" } }, + "GuadrailAction": { + "base": null, + "refs": { + "RetrieveAndGenerateResponse$guardrailAction": "Specifies if there is a guardrail intervention in the response.
" + } + }, + "GuardrailConfiguration": { + "base": "The configuration details for the guardrail.
", + "refs": { + "ExternalSourcesGenerationConfiguration$guardrailConfiguration": "The configuration details for the guardrail.
", + "GenerationConfiguration$guardrailConfiguration": "The configuration details for the guardrail.
" + } + }, + "GuardrailConfigurationGuardrailIdString": { + "base": null, + "refs": { + "GuardrailConfiguration$guardrailId": "The unique identifier for the guardrail.
" + } + }, + "GuardrailConfigurationGuardrailVersionString": { + "base": null, + "refs": { + "GuardrailConfiguration$guardrailVersion": "The version of the guardrail.
" + } + }, "Identifier": { "base": null, "refs": { "ByteContentDoc$identifier": "The file name of the document contained in the wrapper object.
" } }, + "InferenceConfig": { + "base": "The configuration for inference settings when generating responses using RetrieveAndGenerate.
", + "refs": { + "ExternalSourcesGenerationConfiguration$inferenceConfig": "Configuration settings for inference when using RetrieveAndGenerate to generate responses while using an external source.
", + "GenerationConfiguration$inferenceConfig": "Configuration settings for inference when using RetrieveAndGenerate to generate responses while using a knowledge base as a source.
" + } + }, "InferenceConfiguration": { "base": "Specifications about the inference parameters that were provided alongside the prompt. These are specified in the PromptOverrideConfiguration object that was set when the agent was created or updated. For more information, see Inference parameters for foundation models.
", "refs": { @@ -333,7 +384,7 @@ "InputText": { "base": null, "refs": { - "InvokeAgentRequest$inputText": "The prompt text to send the agent.
" + "InvokeAgentRequest$inputText": "The prompt text to send the agent.
If you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.
Contains details about the API operation or function that the agent predicts should be called.
This data type is used in the following API operations:
In the returnControl field of the Retrieve response
Contains details about the API operation or function that the agent predicts should be called.
This data type is used in the following API operations:
In the returnControl field of the InvokeAgent response
A result from the action group invocation.
This data type is used in the following API operations:
", + "base": "A result from the invocation of an action. For more information, see Return control to the agent developer and Control session context.
This data type is used in the following API operations:
", "refs": { "ReturnControlInvocationResults$member": null } @@ -474,6 +525,12 @@ "ModelInvocationInput$overrideLambda": "The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence.
" } }, + "MaxTokens": { + "base": null, + "refs": { + "TextInferenceConfig$maxTokens": "The maximum number of tokens to generate in the output text. Do not use the minimum of 0 or the maximum of 65536. The limit values described here are arbitary values, for actual values consult the limits defined by your specific model.
" + } + }, "MaximumLength": { "base": null, "refs": { @@ -634,6 +691,18 @@ "ApiContentMap$value": null } }, + "RAGStopSequences": { + "base": null, + "refs": { + "TextInferenceConfig$stopSequences": "A list of sequences of characters that, if generated, will cause the model to stop generating further tokens. Do not use a minimum length of 1 or a maximum length of 1000. The limit values described here are arbitary values, for actual values consult the limits defined by your specific model.
" + } + }, + "RAGStopSequencesMemberString": { + "base": null, + "refs": { + "RAGStopSequences$member": null + } + }, "Rationale": { "base": "Contains the reasoning, based on the input, that the agent uses to justify carrying out an action group or getting information from a knowledge base.
", "refs": { @@ -668,8 +737,8 @@ "ResponseBody": { "base": null, "refs": { - "ApiResult$responseBody": "The response body from the API operation. The key of the object is the content type. The response may be returned directly or from the Lambda function.
", - "FunctionResult$responseBody": "The response from the function call using the parameters. The response may be returned directly or from the Lambda function.
" + "ApiResult$responseBody": "The response body from the API operation. The key of the object is the content type (currently, only TEXT is supported). The response may be returned directly or from the Lambda function.
The response from the function call using the parameters. The key of the object is the content type (currently, only TEXT is supported). The response may be returned directly or from the Lambda function.
Contains the cited text from the data source.
This data type is used in the following API operations:
Retrieve response – in the content field
RetrieveAndGenerate response – in the content field
Retrieve response – in the content field
Contains the cited text from the data source.
This data type is used in the following API operations:
Retrieve response – in the content field
RetrieveAndGenerate response – in the content field
InvokeAgent response – in the content field
Contains a chunk of text from a data source in the knowledge base.
", "RetrievedReference$content": "Contains the cited text from the data source.
" } }, "RetrievalResultLocation": { - "base": "Contains information about the location of the data source.
This data type is used in the following API operations:
Retrieve response – in the location field
RetrieveAndGenerate response – in the location field
Retrieve response – in the locatino field
Contains information about the location of the data source.
This data type is used in the following API operations:
Retrieve response – in the location field
RetrieveAndGenerate response – in the location field
InvokeAgent response – in the locatino field
Contains information about the location of the data source.
", "RetrievedReference$location": "Contains information about the location of the data source.
" @@ -739,7 +808,7 @@ } }, "RetrievalResultS3Location": { - "base": "Contains the S3 location of the data source.
This data type is used in the following API operations:
Retrieve response – in the s3Location field
RetrieveAndGenerate response – in the s3Location field
Retrieve response – in the s3Location field
Contains the S3 location of the data source.
This data type is used in the following API operations:
Retrieve response – in the s3Location field
RetrieveAndGenerate response – in the s3Location field
InvokeAgent response – in the s3Location field
Contains the S3 location of the data source.
" } @@ -801,7 +870,7 @@ } }, "RetrievedReference": { - "base": "Contains metadata about a source cited for the generated response.
This data type is used in the following API operations:
RetrieveAndGenerate response – in the retrievedReferences field
Retrieve response – in the retrievedReferences field
Contains metadata about a source cited for the generated response.
This data type is used in the following API operations:
RetrieveAndGenerate response – in the retrievedReferences field
InvokeAgent response – in the retrievedReferences field
Contains information about the results from the action group invocation.
" + "SessionState$returnControlInvocationResults": "Contains information about the results from the action group invocation. For more information, see Return control to the agent developer and Control session context.
If you include this field, the inputText field will be ignored.
Contains information to return from the action group that the agent has predicted to invoke.
This data type is used in the following API operations:
", + "base": "Contains information to return from the action group that the agent has predicted to invoke.
This data type is used in the following API operations:
", "refs": { "ResponseStream$returnControl": "Contains the parameters and information that the agent elicited from the customer to carry out an action. This information is returned to the system and can be used in your own setup for fulfilling the action.
" } @@ -868,7 +937,7 @@ "SessionState": { "base": "Contains parameters that specify various attributes that persist across a session or prompt. You can define session state attributes as key-value pairs when writing a Lambda function for an action group or pass them when making an InvokeAgent request. Use session state attributes to control and provide conversational context for your agent and to help customize your agent's behavior. For more information, see Control session context.
", "refs": { - "InvokeAgentRequest$sessionState": "Contains parameters that specify various attributes of the session. For more information, see Control session context.
" + "InvokeAgentRequest$sessionState": "Contains parameters that specify various attributes of the session. For more information, see Control session context.
If you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.
Contains information about where the text with a citation begins and ends in the generated output.
This data type is used in the following API operations:
RetrieveAndGenerate response – in the span field
Retrieve response – in the span field
Contains information about where the text with a citation begins and ends in the generated output.
This data type is used in the following API operations:
RetrieveAndGenerate response – in the span field
InvokeAgent response – in the span field
Contains information about where the text with a citation begins and ends in the generated output.
" } @@ -934,7 +1003,7 @@ "ReturnControlPayload$invocationId": "The identifier of the action group invocation.
", "SessionAttributesMap$key": null, "SessionAttributesMap$value": null, - "SessionState$invocationId": "The identifier of the invocation.
", + "SessionState$invocationId": "The identifier of the invocation of an action. This value must match the invocationId returned in the InvokeAgent response for the action whose results are provided in the returnControlInvocationResults field. For more information, see Return control to the agent developer and Control session context.
The part of the generated text that contains a citation.
" } @@ -942,7 +1011,14 @@ "Temperature": { "base": null, "refs": { - "InferenceConfiguration$temperature": "The likelihood of the model selecting higher-probability options while generating a response. A lower value makes the model more likely to choose higher-probability options, while a higher value makes the model more likely to choose lower-probability options.
" + "InferenceConfiguration$temperature": "The likelihood of the model selecting higher-probability options while generating a response. A lower value makes the model more likely to choose higher-probability options, while a higher value makes the model more likely to choose lower-probability options.
", + "TextInferenceConfig$temperature": "Controls the random-ness of text generated by the language model, influencing how much the model sticks to the most predictable next words versus exploring more surprising options. A lower temperature value (e.g. 0.2 or 0.3) makes model outputs more deterministic or predictable, while a higher temperature (e.g. 0.8 or 0.9) makes the outputs more creative or unpredictable.
" + } + }, + "TextInferenceConfig": { + "base": "Configuration settings for text generation using a language model via the RetrieveAndGenerate operation. Includes parameters like temperature, top-p, maximum token count, and stop sequences.
The valid range of maxTokens depends on the accepted values for your chosen model's inference parameters. To see the inference parameters for your model, see Inference parameters for foundation models.
Configuration settings specific to text generation while generating responses using RetrieveAndGenerate.
" } }, "TextPromptTemplate": { @@ -952,7 +1028,7 @@ } }, "TextResponsePart": { - "base": "Contains the part of the generated text that contains a citation, alongside where it begins and ends.
This data type is used in the following API operations:
RetrieveAndGenerate response – in the textResponsePart field
Retrieve response – in the textResponsePart field
Contains the part of the generated text that contains a citation, alongside where it begins and ends.
This data type is used in the following API operations:
RetrieveAndGenerate response – in the textResponsePart field
InvokeAgent response – in the textResponsePart field
Contains metadata about a textual part of the generated response that is accompanied by a citation.
" } @@ -972,7 +1048,8 @@ "TopP": { "base": null, "refs": { - "InferenceConfiguration$topP": "While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for Top P determines the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topP to 80, the model only selects the next token from the top 80% of the probability distribution of next tokens.
While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for Top P determines the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topP to 80, the model only selects the next token from the top 80% of the probability distribution of next tokens.
A probability distribution threshold which controls what the model considers for the set of possible next tokens. The model will only consider the top p% of the probability distribution when generating the next token.
" } }, "Trace": { diff --git a/models/apis/pinpoint/2016-12-01/api-2.json b/models/apis/pinpoint/2016-12-01/api-2.json index 31ac3806fdf..245f8b0db52 100644 --- a/models/apis/pinpoint/2016-12-01/api-2.json +++ b/models/apis/pinpoint/2016-12-01/api-2.json @@ -5426,6 +5426,9 @@ "FromAddress": { "shape": "__string" }, + "Headers": { + "shape": "ListOfMessageHeader" + }, "HtmlBody": { "shape": "__string" }, @@ -7124,6 +7127,9 @@ "Subject": { "shape": "__string" }, + "Headers": { + "shape": "ListOfMessageHeader" + }, "tags": { "shape": "MapOf__string", "locationName": "tags" @@ -7160,6 +7166,9 @@ "Subject": { "shape": "__string" }, + "Headers": { + "shape": "ListOfMessageHeader" + }, "tags": { "shape": "MapOf__string", "locationName": "tags" @@ -11934,9 +11943,29 @@ }, "TextPart": { "shape": "SimpleEmailPart" + }, + "Headers": { + "shape": "ListOfMessageHeader" } } }, + "ListOfMessageHeader": { + "type": "list", + "member": { + "shape": "MessageHeader" + } + }, + "MessageHeader": { + "type": "structure", + "members": { + "Name": { + "shape": "__string" + }, + "Value": { + "shape": "__string" + } + } + }, "SimpleEmailPart": { "type": "structure", "members": { diff --git a/models/apis/pinpoint/2016-12-01/docs-2.json b/models/apis/pinpoint/2016-12-01/docs-2.json index 357edb5234b..80ab6fc995e 100644 --- a/models/apis/pinpoint/2016-12-01/docs-2.json +++ b/models/apis/pinpoint/2016-12-01/docs-2.json @@ -976,6 +976,12 @@ "WriteTreatmentResource$MessageConfiguration": "The message configuration settings for the treatment.
" } }, + "MessageHeader" : { + "base" : "Contains the name and value pair of an email header to add to your email. You can have up to 15 MessageHeaders. A header can contain information such as the sender, receiver, route, or timestamp.
", + "refs" : { + "ListOfMessageHeader$member" : null + } + }, "MessageRequest": { "base": "Specifies the configuration and other settings for a message.
", "refs": {} @@ -1733,6 +1739,14 @@ "JourneyRunsResponse$Item": "An array of responses, one for each run of the journey
" } }, + "ListOfMessageHeader" : { + "base" : null, + "refs" : { + "EmailTemplateRequest$Headers" : "The list of MessageHeaders for the email. You can have up to 15 Headers.
", + "SimpleEmail$Headers" : "List of Headers for the email.
", + "CampaignEmailMessage$Headers" : "The list of MessageHeaders for the email. You can have up to 15 MessageHeaders for each email.
" + } + }, "ListOfMultiConditionalBranch": { "base": null, "refs": { @@ -2456,6 +2470,8 @@ "MessageBody$Message": "The message that's returned from the API.
", "MessageBody$RequestID": "The unique identifier for the request or response.
", "MessageRequest$TraceId": "The unique identifier for tracing the message. This identifier is visible to message recipients.
", + "MessageHeader$Name" : "The name of the message header. The header name can contain up to 126 characters.
", + "MessageHeader$Value" : "The value of the message header. The header value can contain up to 870 characters, including the length of any rendered attributes. For example if you add the {CreationDate} attribute, it renders as YYYY-MM-DDTHH:MM:SS.SSSZ and is 24 characters in length.
", "MessageResponse$ApplicationId": "The unique identifier for the application that was used to send the message.
", "MessageResponse$RequestId": "The identifier for the original request that the message was delivered for.
", "MessageResult$MessageId": "The unique identifier for the message that was sent.
", diff --git a/models/apis/route53resolver/2018-04-01/docs-2.json b/models/apis/route53resolver/2018-04-01/docs-2.json index 6d28d0364f6..7850a8481f2 100644 --- a/models/apis/route53resolver/2018-04-01/docs-2.json +++ b/models/apis/route53resolver/2018-04-01/docs-2.json @@ -552,9 +552,9 @@ "FirewallDomainRedirectionAction": { "base": null, "refs": { - "CreateFirewallRuleRequest$FirewallDomainRedirectionAction": "How you want the the rule to evaluate DNS redirection in the DNS redirection chain, such as CNAME, DNAME, ot ALIAS.
Inspect_Redirection_Domain (Default) inspects all domains in the redirection chain. The individual domains in the redirection chain must be added to the allow domain list.
Trust_Redirection_Domain inspects only the first domain in the redirection chain. You don't need to add the subsequent domains in the redirection list to the domain alloww list.
How you want the the rule to evaluate DNS redirection in the DNS redirection chain, such as CNAME, DNAME, ot ALIAS.
Inspect_Redirection_Domain (Default) inspects all domains in the redirection chain. The individual domains in the redirection chain must be added to the allow domain list.
Trust_Redirection_Domain inspects only the first domain in the redirection chain. You don't need to add the subsequent domains in the domain in the redirection list to the domain alloww list.
How you want the the rule to evaluate DNS redirection in the DNS redirection chain, such as CNAME, DNAME, ot ALIAS.
Inspect_Redirection_Domain (Default) inspects all domains in the redirection chain. The individual domains in the redirection chain must be added to the allow domain list.
Trust_Redirection_Domain inspects only the first domain in the redirection chain. You don't need to add the subsequent domains in the domain in the redirection list to the domain alloww list.
How you want the the rule to evaluate DNS redirection in the DNS redirection chain, such as CNAME or DNAME.
Inspect_Redirection_Domain (Default) inspects all domains in the redirection chain. The individual domains in the redirection chain must be added to the domain list.
Trust_Redirection_Domain inspects only the first domain in the redirection chain. You don't need to add the subsequent domains in the domain in the redirection list to the domain list.
How you want the the rule to evaluate DNS redirection in the DNS redirection chain, such as CNAME or DNAME.
Inspect_Redirection_Domain (Default) inspects all domains in the redirection chain. The individual domains in the redirection chain must be added to the domain list.
Trust_Redirection_Domain inspects only the first domain in the redirection chain. You don't need to add the subsequent domains in the domain in the redirection list to the domain list.
How you want the the rule to evaluate DNS redirection in the DNS redirection chain, such as CNAME or DNAME.
Inspect_Redirection_Domain (Default) inspects all domains in the redirection chain. The individual domains in the redirection chain must be added to the domain list.
Trust_Redirection_Domain inspects only the first domain in the redirection chain. You don't need to add the subsequent domains in the domain in the redirection list to the domain list.
Lists all the applications registered with AWS Systems Manager for SAP.
", "ListComponents": "Lists all the components registered with AWS Systems Manager for SAP.
", "ListDatabases": "Lists the SAP HANA databases of an application registered with AWS Systems Manager for SAP.
", + "ListOperationEvents": "Returns a list of operations events.
Available parameters include OperationID, as well as optional parameters MaxResults, NextToken, and Filters.
Lists the operations performed by AWS Systems Manager for SAP.
", "ListTagsForResource": "Lists all tags on an SAP HANA application and/or database registered with AWS Systems Manager for SAP.
", "PutResourcePermission": "Adds permissions to the target database.
", "RegisterApplication": "Register an SAP application with AWS Systems Manager for SAP. You must meet the following requirements before registering.
The SAP application you want to register with AWS Systems Manager for SAP is running on Amazon EC2.
AWS Systems Manager Agent must be setup on an Amazon EC2 instance along with the required IAM permissions.
Amazon EC2 instance(s) must have access to the secrets created in AWS Secrets Manager to manage SAP applications and components.
", + "StartApplication": "Request is an operation which starts an application.
Parameter ApplicationId is required.
Refreshes a registered application.
", + "StopApplication": "Request is an operation to stop an application.
Parameter ApplicationId is required. Parameters StopConnectedEntity and IncludeEc2InstanceShutdown are optional.
Creates tag for a resource by specifying the ARN.
", "UntagResource": "Delete the tags for a resource.
", "UpdateApplicationSettings": "Updates the settings of an application registered with AWS Systems Manager for SAP.
" @@ -81,7 +84,9 @@ "ListDatabasesInput$ApplicationId": "The ID of the application.
", "ListOperationsInput$ApplicationId": "The ID of the application.
", "RegisterApplicationInput$ApplicationId": "The ID of the application.
", + "StartApplicationInput$ApplicationId": "The ID of the application.
", "StartApplicationRefreshInput$ApplicationId": "The ID of the application.
", + "StopApplicationInput$ApplicationId": "The ID of the application.
", "UpdateApplicationSettingsInput$ApplicationId": "The ID of the application.
" } }, @@ -119,7 +124,8 @@ "GetResourcePermissionInput$ResourceArn": "The Amazon Resource Name (ARN) of the resource.
", "Operation$ResourceArn": "The Amazon Resource Name (ARN) of the operation.
", "PutResourcePermissionInput$SourceResourceArn": "", - "PutResourcePermissionInput$ResourceArn": "" + "PutResourcePermissionInput$ResourceArn": "", + "Resource$ResourceArn": "The Amazon Resource Name (ARN) of the source resource.
Example of ResourceArn: \"arn:aws:ec2:us-east-1:111111111111:instance/i-abcdefgh987654321\"
The primary IP address.
", - "Resilience$EnqueueReplication": "Indicates if or not enqueue replication is enabled for the ASCS component.
" + "Resilience$EnqueueReplication": "Indicates if or not enqueue replication is enabled for the ASCS component.
", + "StopApplicationInput$IncludeEc2InstanceShutdown": "Boolean. If included and if set to True, the StopApplication operation will shut down the associated Amazon EC2 instance in addition to the application.
Specify the ConnectedEntityType. Accepted type is DBMS.
If this parameter is included, the connected DBMS (Database Management System) will be stopped.
" + } + }, "CredentialType": { "base": null, "refs": { @@ -311,6 +324,7 @@ "base": null, "refs": { "ListApplicationsInput$Filters": "The filter of name, value, and operator.
", + "ListOperationEventsInput$Filters": "Optionally specify filters to narrow the returned operation event items.
Valid filter names include status, resourceID, and resourceType. The valid operator for all three filters is Equals.
The filters of an operation.
" } }, @@ -465,6 +479,16 @@ "refs": { } }, + "ListOperationEventsInput": { + "base": null, + "refs": { + } + }, + "ListOperationEventsOutput": { + "base": null, + "refs": { + } + }, "ListOperationsInput": { "base": null, "refs": { @@ -488,9 +512,10 @@ "MaxResults": { "base": null, "refs": { - "ListApplicationsInput$MaxResults": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
", + "ListApplicationsInput$MaxResults": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
", "ListComponentsInput$MaxResults": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
If you do not specify a value for MaxResults, the request returns 50 items per page by default.
", "ListDatabasesInput$MaxResults": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. If you do not specify a value for MaxResults, the request returns 50 items per page by default.
", + "ListOperationEventsInput$MaxResults": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
If you do not specify a value for MaxResults, the request returns 50 items per page by default.
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. If you do not specify a value for MaxResults, the request returns 50 items per page by default.
" } }, @@ -503,6 +528,8 @@ "ListComponentsOutput$NextToken": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
", "ListDatabasesInput$NextToken": "The token for the next page of results.
", "ListDatabasesOutput$NextToken": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
", + "ListOperationEventsInput$NextToken": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
", + "ListOperationEventsOutput$NextToken": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
", "ListOperationsInput$NextToken": "The token for the next page of results.
", "ListOperationsOutput$NextToken": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
" } @@ -514,14 +541,41 @@ "OperationList$member": null } }, + "OperationEvent": { + "base": "An operation event returns details for an operation, including key milestones which can be used to monitor and track operations in progress.
Operation events contain:
Description string
Resource, including its ARN and type
Status
StatusMessage string
TimeStamp
Operation event examples include StartApplication or StopApplication.
", + "refs": { + "OperationEventList$member": null + } + }, + "OperationEventList": { + "base": null, + "refs": { + "ListOperationEventsOutput$OperationEvents": "A returned list of operation events that meet the filter criteria.
" + } + }, + "OperationEventResourceType": { + "base": null, + "refs": { + "Resource$ResourceType": "The resource type.
Example of ResourceType: \"AWS::SystemsManagerSAP::Component\" or \"AWS::EC2::Instance\".
The status of the operation event. The possible statuses are: IN_PROGRESS, COMPLETED, and FAILED.
The ID of the operation.
", + "ListOperationEventsInput$OperationId": "The ID of the operation.
", "Operation$Id": "The ID of the operation.
", "OperationIdList$member": null, "RegisterApplicationOutput$OperationId": "The ID of the operation.
", - "StartApplicationRefreshOutput$OperationId": "The ID of the operation.
" + "StartApplicationOutput$OperationId": "The ID of the operation.
", + "StartApplicationRefreshOutput$OperationId": "The ID of the operation.
", + "StopApplicationOutput$OperationId": "The ID of the operation.
" } }, "OperationIdList": { @@ -600,6 +654,12 @@ "Component$Resilience": "Details of the SAP HANA system replication for the component.
" } }, + "Resource": { + "base": "The resource contains a ResourceArn and the ResourceType.
The resource involved in the operations event.
Contains ResourceArn ARN and ResourceType.
The Amazon Resource Name of the SAP HANA database that replaces the current SAP HANA connection with the SAP_ABAP application.
" } }, + "StartApplicationInput": { + "base": null, + "refs": { + } + }, + "StartApplicationOutput": { + "base": null, + "refs": { + } + }, "StartApplicationRefreshInput": { "base": null, "refs": { @@ -666,6 +736,16 @@ "refs": { } }, + "StopApplicationInput": { + "base": null, + "refs": { + } + }, + "StopApplicationOutput": { + "base": null, + "refs": { + } + }, "String": { "base": null, "refs": { @@ -692,6 +772,8 @@ "InternalServerException$Message": null, "IpAddressMember$IpAddress": "The IP address.
", "Operation$StatusMessage": "The status message of the operation.
", + "OperationEvent$Description": "A description of the operation event. For example, \"Stop the EC2 instance i-abcdefgh987654321\".
", + "OperationEvent$StatusMessage": "The status message relating to a specific operation event.
", "OperationProperties$key": null, "OperationProperties$value": null, "PutResourcePermissionOutput$Policy": "", @@ -753,7 +835,8 @@ "Database$LastUpdated": "The time at which the database was last updated.
", "Operation$StartTime": "The start time of the operation.
", "Operation$EndTime": "The end time of the operation.
", - "Operation$LastUpdatedTime": "The time at which the operation was last updated.
" + "Operation$LastUpdatedTime": "The time at which the operation was last updated.
", + "OperationEvent$Timestamp": "The timestamp of the specified operation event.
" } }, "UnauthorizedException": { diff --git a/models/apis/ssm-sap/2018-05-10/paginators-1.json b/models/apis/ssm-sap/2018-05-10/paginators-1.json index 1b25777b54e..d438314f163 100644 --- a/models/apis/ssm-sap/2018-05-10/paginators-1.json +++ b/models/apis/ssm-sap/2018-05-10/paginators-1.json @@ -18,6 +18,12 @@ "limit_key": "MaxResults", "result_key": "Databases" }, + "ListOperationEvents": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "OperationEvents" + }, "ListOperations": { "input_token": "NextToken", "output_token": "NextToken", diff --git a/models/apis/verifiedpermissions/2021-12-01/api-2.json b/models/apis/verifiedpermissions/2021-12-01/api-2.json index e0ed557c580..670dd9e6cc3 100644 --- a/models/apis/verifiedpermissions/2021-12-01/api-2.json +++ b/models/apis/verifiedpermissions/2021-12-01/api-2.json @@ -5,6 +5,7 @@ "endpointPrefix":"verifiedpermissions", "jsonVersion":"1.0", "protocol":"json", + "protocols":["json"], "serviceFullName":"Amazon Verified Permissions", "serviceId":"VerifiedPermissions", "signatureVersion":"v4", @@ -485,6 +486,10 @@ "actionId":{"shape":"ActionId"} } }, + "ActionIdentifierList":{ + "type":"list", + "member":{"shape":"ActionIdentifier"} + }, "ActionType":{ "type":"string", "max":200, @@ -794,8 +799,10 @@ "policyType":{"shape":"PolicyType"}, "principal":{"shape":"EntityIdentifier"}, "resource":{"shape":"EntityIdentifier"}, + "actions":{"shape":"ActionIdentifierList"}, "createdDate":{"shape":"TimestampFormat"}, - "lastUpdatedDate":{"shape":"TimestampFormat"} + "lastUpdatedDate":{"shape":"TimestampFormat"}, + "effect":{"shape":"PolicyEffect"} } }, "CreatePolicyStoreInput":{ @@ -1071,9 +1078,11 @@ "policyType":{"shape":"PolicyType"}, "principal":{"shape":"EntityIdentifier"}, "resource":{"shape":"EntityIdentifier"}, + "actions":{"shape":"ActionIdentifierList"}, "definition":{"shape":"PolicyDefinitionDetail"}, "createdDate":{"shape":"TimestampFormat"}, - "lastUpdatedDate":{"shape":"TimestampFormat"} + "lastUpdatedDate":{"shape":"TimestampFormat"}, + "effect":{"shape":"PolicyEffect"} } }, "GetPolicyStoreInput":{ @@ -1467,6 +1476,13 @@ }, "union":true }, + "PolicyEffect":{ + "type":"string", + "enum":[ + "Permit", + "Forbid" + ] + }, "PolicyFilter":{ "type":"structure", "members":{ @@ -1498,9 +1514,11 @@ "policyType":{"shape":"PolicyType"}, "principal":{"shape":"EntityIdentifier"}, "resource":{"shape":"EntityIdentifier"}, + "actions":{"shape":"ActionIdentifierList"}, "definition":{"shape":"PolicyDefinitionItem"}, "createdDate":{"shape":"TimestampFormat"}, - "lastUpdatedDate":{"shape":"TimestampFormat"} + "lastUpdatedDate":{"shape":"TimestampFormat"}, + "effect":{"shape":"PolicyEffect"} } }, "PolicyList":{ @@ -1867,8 +1885,10 @@ "policyType":{"shape":"PolicyType"}, "principal":{"shape":"EntityIdentifier"}, "resource":{"shape":"EntityIdentifier"}, + "actions":{"shape":"ActionIdentifierList"}, "createdDate":{"shape":"TimestampFormat"}, - "lastUpdatedDate":{"shape":"TimestampFormat"} + "lastUpdatedDate":{"shape":"TimestampFormat"}, + "effect":{"shape":"PolicyEffect"} } }, "UpdatePolicyStoreInput":{ diff --git a/models/apis/verifiedpermissions/2021-12-01/docs-2.json b/models/apis/verifiedpermissions/2021-12-01/docs-2.json index 032b1831b2c..a0bc37bb0e8 100644 --- a/models/apis/verifiedpermissions/2021-12-01/docs-2.json +++ b/models/apis/verifiedpermissions/2021-12-01/docs-2.json @@ -44,12 +44,22 @@ "ActionIdentifier": { "base": "Contains information about an action for a request for which an authorization decision is made.
This data type is used as a request parameter to the IsAuthorized, BatchIsAuthorized, and IsAuthorizedWithToken operations.
Example: { \"actionId\": \"<action name>\", \"actionType\": \"Action\" }
Specifies the requested action to be authorized. For example, PhotoFlash::ReadPhoto.
Specifies the requested action to be authorized. For example, PhotoFlash::ReadPhoto.
Specifies the requested action to be authorized. For example, is the principal authorized to perform this action on the resource?
", "IsAuthorizedWithTokenInput$action": "Specifies the requested action to be authorized. Is the specified principal authorized to perform this action on the specified resource.
" } }, + "ActionIdentifierList": { + "base": null, + "refs": { + "CreatePolicyOutput$actions": "The action that a policy permits or forbids. For example, {\"actions\": [{\"actionId\": \"ViewPhoto\", \"actionType\": \"PhotoFlash::Action\"}, {\"entityID\": \"SharePhoto\", \"entityType\": \"PhotoFlash::Action\"}]}.
The action that a policy permits or forbids. For example, {\"actions\": [{\"actionId\": \"ViewPhoto\", \"actionType\": \"PhotoFlash::Action\"}, {\"entityID\": \"SharePhoto\", \"entityType\": \"PhotoFlash::Action\"}]}.
The action that a policy permits or forbids. For example, {\"actions\": [{\"actionId\": \"ViewPhoto\", \"actionType\": \"PhotoFlash::Action\"}, {\"entityID\": \"SharePhoto\", \"entityType\": \"PhotoFlash::Action\"}]}.
The action that a policy permits or forbids. For example, {\"actions\": [{\"actionId\": \"ViewPhoto\", \"actionType\": \"PhotoFlash::Action\"}, {\"entityID\": \"SharePhoto\", \"entityType\": \"PhotoFlash::Action\"}]}.
A list of user groups and entities from an Amazon Cognito user pool identity source.
This data type is part of a CognitoUserPoolConfiguration structure and is a request parameter in CreateIdentitySource.
", + "base": "The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.
This data type is part of a CognitoUserPoolConfiguration structure and is a request parameter in CreateIdentitySource.
", "refs": { - "CognitoUserPoolConfiguration$groupConfiguration": "The configuration of the user groups from an Amazon Cognito user pool identity source.
" + "CognitoUserPoolConfiguration$groupConfiguration": "The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.
" } }, "CognitoGroupConfigurationDetail": { - "base": "A list of user groups and entities from an Amazon Cognito user pool identity source.
This data type is part of an CognitoUserPoolConfigurationDetail structure and is a response parameter to GetIdentitySource.
", + "base": "The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.
This data type is part of an CognitoUserPoolConfigurationDetail structure and is a response parameter to GetIdentitySource.
", "refs": { - "CognitoUserPoolConfigurationDetail$groupConfiguration": "The configuration of the user groups from an Amazon Cognito user pool identity source.
" + "CognitoUserPoolConfigurationDetail$groupConfiguration": "The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.
" } }, "CognitoGroupConfigurationItem": { - "base": "A list of user groups and entities from an Amazon Cognito user pool identity source.
This data type is part of an CognitoUserPoolConfigurationItem structure and is a response parameter to ListIdentitySources.
", + "base": "The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.
This data type is part of an CognitoUserPoolConfigurationItem structure and is a response parameter to ListIdentitySources.
", "refs": { - "CognitoUserPoolConfigurationItem$groupConfiguration": "The configuration of the user groups from an Amazon Cognito user pool identity source.
" + "CognitoUserPoolConfigurationItem$groupConfiguration": "The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.
" } }, "CognitoUserPoolConfiguration": { - "base": "The configuration for an identity source that represents a connection to an Amazon Cognito user pool used as an identity provider for Verified Permissions.
This data type is used as a field that is part of an Configuration structure that is used as a parameter to CreateIdentitySource.
Example:\"CognitoUserPoolConfiguration\":{\"UserPoolArn\":\"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\",\"ClientIds\": [\"a1b2c3d4e5f6g7h8i9j0kalbmc\"]}
The configuration for an identity source that represents a connection to an Amazon Cognito user pool used as an identity provider for Verified Permissions.
This data type is used as a field that is part of an Configuration structure that is used as a parameter to CreateIdentitySource.
Example:\"CognitoUserPoolConfiguration\":{\"UserPoolArn\":\"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\",\"ClientIds\": [\"a1b2c3d4e5f6g7h8i9j0kalbmc\"],\"groupConfiguration\": {\"groupEntityType\": \"MyCorp::Group\"}}
Contains configuration details of a Amazon Cognito user pool that Verified Permissions can use as a source of authenticated identities as entities. It specifies the Amazon Resource Name (ARN) of a Amazon Cognito user pool and one or more application client IDs.
Example: \"configuration\":{\"cognitoUserPoolConfiguration\":{\"userPoolArn\":\"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\",\"clientIds\": [\"a1b2c3d4e5f6g7h8i9j0kalbmc\"],\"groupConfiguration\": {\"groupEntityType\": \"MyCorp::Group\"}}}
The configuration for an identity source that represents a connection to an Amazon Cognito user pool used as an identity provider for Verified Permissions.
This data type is used as a field that is part of an ConfigurationDetail structure that is part of the response to GetIdentitySource.
Example:\"CognitoUserPoolConfiguration\":{\"UserPoolArn\":\"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\",\"ClientIds\": [\"a1b2c3d4e5f6g7h8i9j0kalbmc\"]}
The configuration for an identity source that represents a connection to an Amazon Cognito user pool used as an identity provider for Verified Permissions.
This data type is used as a field that is part of an ConfigurationDetail structure that is part of the response to GetIdentitySource.
Example:\"CognitoUserPoolConfiguration\":{\"UserPoolArn\":\"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\",\"ClientIds\": [\"a1b2c3d4e5f6g7h8i9j0kalbmc\"],\"groupConfiguration\": {\"groupEntityType\": \"MyCorp::Group\"}}
Contains configuration details of a Amazon Cognito user pool that Verified Permissions can use as a source of authenticated identities as entities. It specifies the Amazon Resource Name (ARN) of a Amazon Cognito user pool and one or more application client IDs.
Example: \"configuration\":{\"cognitoUserPoolConfiguration\":{\"userPoolArn\":\"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\",\"clientIds\": [\"a1b2c3d4e5f6g7h8i9j0kalbmc\"],\"groupConfiguration\": {\"groupEntityType\": \"MyCorp::Group\"}}}
Contains configuration details of a Amazon Cognito user pool that Verified Permissions can use as a source of authenticated identities as entities. It specifies the Amazon Resource Name (ARN) of a Amazon Cognito user pool, the policy store entity that you want to assign to user groups, and one or more application client IDs.
Example: \"configuration\":{\"cognitoUserPoolConfiguration\":{\"userPoolArn\":\"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\",\"clientIds\": [\"a1b2c3d4e5f6g7h8i9j0kalbmc\"],\"groupConfiguration\": {\"groupEntityType\": \"MyCorp::Group\"}}}
The configuration for an identity source that represents a connection to an Amazon Cognito user pool used as an identity provider for Verified Permissions.
This data type is used as a field that is part of the ConfigurationItem structure that is part of the response to ListIdentitySources.
Example:\"CognitoUserPoolConfiguration\":{\"UserPoolArn\":\"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\",\"ClientIds\": [\"a1b2c3d4e5f6g7h8i9j0kalbmc\"]}
The configuration for an identity source that represents a connection to an Amazon Cognito user pool used as an identity provider for Verified Permissions.
This data type is used as a field that is part of the ConfigurationItem structure that is part of the response to ListIdentitySources.
Example:\"CognitoUserPoolConfiguration\":{\"UserPoolArn\":\"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\",\"ClientIds\": [\"a1b2c3d4e5f6g7h8i9j0kalbmc\"],\"groupConfiguration\": {\"groupEntityType\": \"MyCorp::Group\"}}
Contains configuration details of a Amazon Cognito user pool that Verified Permissions can use as a source of authenticated identities as entities. It specifies the Amazon Resource Name (ARN) of a Amazon Cognito user pool and one or more application client IDs.
Example: \"configuration\":{\"cognitoUserPoolConfiguration\":{\"userPoolArn\":\"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\",\"clientIds\": [\"a1b2c3d4e5f6g7h8i9j0kalbmc\"],\"groupConfiguration\": {\"groupEntityType\": \"MyCorp::Group\"}}}
Contains configuration details of a Amazon Cognito user pool that Verified Permissions can use as a source of authenticated identities as entities. It specifies the Amazon Resource Name (ARN) of a Amazon Cognito user pool, the policy store entity that you want to assign to user groups, and one or more application client IDs.
Example: \"configuration\":{\"cognitoUserPoolConfiguration\":{\"userPoolArn\":\"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\",\"clientIds\": [\"a1b2c3d4e5f6g7h8i9j0kalbmc\"],\"groupConfiguration\": {\"groupEntityType\": \"MyCorp::Group\"}}}
Contains configuration information used when creating a new identity source.
At this time, the only valid member of this structure is a Amazon Cognito user pool configuration.
You must specify a userPoolArn, and optionally, a ClientId.
This data type is used as a request parameter for the CreateIdentitySource operation.
", + "base": "Contains configuration information used when creating a new identity source.
At this time, the only valid member of this structure is a Amazon Cognito user pool configuration.
Specifies a userPoolArn, a groupConfiguration, and a ClientId.
This data type is used as a request parameter for the CreateIdentitySource operation.
", "refs": { "CreateIdentitySourceInput$configuration": "Specifies the details required to communicate with the identity provider (IdP) associated with this identity source.
At this time, the only valid member of this structure is a Amazon Cognito user pool configuration.
You must specify a UserPoolArn, and optionally, a ClientId.
Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
If you do not specify this parameter, the operation defaults to 10 identity sources per response. You can specify a maximum of 200 identity sources per response.
" + "ListIdentitySourcesInput$maxResults": "Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
If you do not specify this parameter, the operation defaults to 10 identity sources per response. You can specify a maximum of 50 identity sources per response.
" } }, "ListIdentitySourcesOutput": { @@ -706,6 +716,15 @@ "PolicyItem$definition": "The policy definition of an item in the list of policies returned.
" } }, + "PolicyEffect": { + "base": null, + "refs": { + "CreatePolicyOutput$effect": "The effect of the decision that a policy returns to an authorization request. For example, \"effect\": \"Permit\".
The effect of the decision that a policy returns to an authorization request. For example, \"effect\": \"Permit\".
The effect of the decision that a policy returns to an authorization request. For example, \"effect\": \"Permit\".
The effect of the decision that a policy returns to an authorization request. For example, \"effect\": \"Permit\".
Contains information about a filter to refine policies returned in a query.
This data type is used as a response parameter for the ListPolicies operation.
", "refs": { @@ -1079,7 +1098,7 @@ } }, "UpdateCognitoGroupConfiguration": { - "base": "A list of user groups and entities from an Amazon Cognito user pool identity source.
", + "base": "The user group entities from an Amazon Cognito user pool identity source.
", "refs": { "UpdateCognitoUserPoolConfiguration$groupConfiguration": "The configuration of the user groups from an Amazon Cognito user pool identity source.
" } diff --git a/models/endpoints/endpoints.json b/models/endpoints/endpoints.json index 0ab534e598d..3d786039e43 100644 --- a/models/endpoints/endpoints.json +++ b/models/endpoints/endpoints.json @@ -136,7 +136,12 @@ "tags" : [ "fips" ] } ] }, - "ca-west-1" : { }, + "ca-west-1" : { + "variants" : [ { + "hostname" : "access-analyzer-fips.ca-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "eu-central-1" : { }, "eu-central-2" : { }, "eu-north-1" : { }, @@ -152,6 +157,13 @@ "deprecated" : true, "hostname" : "access-analyzer-fips.ca-central-1.amazonaws.com" }, + "fips-ca-west-1" : { + "credentialScope" : { + "region" : "ca-west-1" + }, + "deprecated" : true, + "hostname" : "access-analyzer-fips.ca-west-1.amazonaws.com" + }, "fips-us-east-1" : { "credentialScope" : { "region" : "us-east-1" @@ -536,6 +548,7 @@ "ap-southeast-2" : { }, "eu-central-1" : { }, "eu-west-1" : { }, + "eu-west-3" : { }, "us-east-1" : { }, "us-east-2" : { }, "us-west-2" : { } @@ -24137,14 +24150,62 @@ }, "emr-containers" : { "endpoints" : { - "us-gov-east-1" : { }, - "us-gov-west-1" : { } + "fips-us-gov-east-1" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "deprecated" : true, + "hostname" : "emr-containers.us-gov-east-1.amazonaws.com" + }, + "fips-us-gov-west-1" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "deprecated" : true, + "hostname" : "emr-containers.us-gov-west-1.amazonaws.com" + }, + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "emr-containers.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "emr-containers.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "emr-serverless" : { "endpoints" : { - "us-gov-east-1" : { }, - "us-gov-west-1" : { } + "fips-us-gov-east-1" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "deprecated" : true, + "hostname" : "emr-serverless.us-gov-east-1.amazonaws.com" + }, + "fips-us-gov-west-1" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "deprecated" : true, + "hostname" : "emr-serverless.us-gov-west-1.amazonaws.com" + }, + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "emr-serverless.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "emr-serverless.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "es" : { diff --git a/service/bedrockagentruntime/api.go b/service/bedrockagentruntime/api.go index 4b169bffb35..31dde1437d2 100644 --- a/service/bedrockagentruntime/api.go +++ b/service/bedrockagentruntime/api.go @@ -72,11 +72,11 @@ func (c *BedrockAgentRuntime) InvokeAgentRequest(input *InvokeAgentInput) (req * // InvokeAgent API operation for Agents for Amazon Bedrock Runtime. // -// Sends a prompt for the agent to process and respond to. Use return control -// event type for function calling. -// // The CLI doesn't support InvokeAgent. // +// Sends a prompt for the agent to process and respond to. Note the following +// fields for the request: +// // - To continue the same conversation with an agent, use the same sessionId // value in the request. // @@ -88,9 +88,8 @@ func (c *BedrockAgentRuntime) InvokeAgentRequest(input *InvokeAgentInput) (req * // - End a conversation by setting endSession to true. // // - In the sessionState object, you can include attributes for the session -// or prompt or parameters returned from the action group. -// -// - Use return control event type for function calling. +// or prompt or, if you configured an action group to return control, results +// from invocation of the action group. // // The response is returned in the bytes field of the chunk object. // @@ -99,6 +98,10 @@ func (c *BedrockAgentRuntime) InvokeAgentRequest(input *InvokeAgentInput) (req * // - If you set enableTrace to true in the request, you can trace the agent's // steps and reasoning process that led it to the response. // +// - If the action predicted was configured to return control, the response +// returns parameters for the action, elicited from the user, in the returnControl +// field. +// // - Errors are also surfaced in the response. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -817,7 +820,7 @@ func (s *ActionGroupInvocationOutput_) SetText(v string) *ActionGroupInvocationO // // This data type is used in the following API operations: // -// - In the returnControl field of the Retrieve response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax) +// - In the returnControl field of the InvokeAgent response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax) type ApiInvocationInput_ struct { _ struct{} `type:"structure"` @@ -897,7 +900,7 @@ func (s *ApiInvocationInput_) SetRequestBody(v *ApiRequestBody) *ApiInvocationIn // // This data type is used in the following API operations: // -// - Retrieve response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax) +// - InvokeAgent response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax) type ApiParameter struct { _ struct{} `type:"structure"` @@ -952,7 +955,7 @@ func (s *ApiParameter) SetValue(v string) *ApiParameter { // // This data type is used in the following API operations: // -// - Retrieve response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax) +// - InvokeAgent response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax) type ApiRequestBody struct { _ struct{} `type:"structure"` @@ -990,7 +993,7 @@ func (s *ApiRequestBody) SetContent(v map[string]*PropertyParameters) *ApiReques // // This data type is used in the following API operations: // -// - In the returnControlInvocationResults of the Retrieve request (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax) +// - In the returnControlInvocationResults of the InvokeAgent request (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_RequestSyntax) type ApiResult struct { _ struct{} `type:"structure"` @@ -1013,7 +1016,8 @@ type ApiResult struct { HttpStatusCode *int64 `locationName:"httpStatusCode" type:"integer"` // The response body from the API operation. The key of the object is the content - // type. The response may be returned directly or from the Lambda function. + // type (currently, only TEXT is supported). The response may be returned directly + // or from the Lambda function. ResponseBody map[string]*ContentBody `locationName:"responseBody" type:"map"` // Controls the final response state returned to end user when API/Function @@ -1315,7 +1319,7 @@ func (s *ByteContentDoc) SetIdentifier(v string) *ByteContentDoc { // // This data type is used in the following API operations: // -// - Retrieve response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax) +// - InvokeAgent response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax) // – in the citations field // // - RetrieveAndGenerate response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax) @@ -1458,8 +1462,8 @@ func (s *ConflictException) RequestID() string { // // This data type is used in the following API operations: // -// - In the returnControlInvocationResults field of the Retrieve request -// (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax) +// - In the returnControlInvocationResults field of the InvokeAgent request +// (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_RequestSyntax) type ContentBody struct { _ struct{} `type:"structure"` @@ -1668,6 +1672,13 @@ func (s *ExternalSource) SetSourceType(v string) *ExternalSource { type ExternalSourcesGenerationConfiguration struct { _ struct{} `type:"structure"` + // The configuration details for the guardrail. + GuardrailConfiguration *GuardrailConfiguration `locationName:"guardrailConfiguration" type:"structure"` + + // Configuration settings for inference when using RetrieveAndGenerate to generate + // responses while using an external source. + InferenceConfig *InferenceConfig `locationName:"inferenceConfig" type:"structure"` + // Contain the textPromptTemplate string for the external source wrapper object. PromptTemplate *PromptTemplate `locationName:"promptTemplate" type:"structure"` } @@ -1693,6 +1704,11 @@ func (s ExternalSourcesGenerationConfiguration) GoString() string { // Validate inspects the fields of the type to determine if they are valid. func (s *ExternalSourcesGenerationConfiguration) Validate() error { invalidParams := request.ErrInvalidParams{Context: "ExternalSourcesGenerationConfiguration"} + if s.GuardrailConfiguration != nil { + if err := s.GuardrailConfiguration.Validate(); err != nil { + invalidParams.AddNested("GuardrailConfiguration", err.(request.ErrInvalidParams)) + } + } if s.PromptTemplate != nil { if err := s.PromptTemplate.Validate(); err != nil { invalidParams.AddNested("PromptTemplate", err.(request.ErrInvalidParams)) @@ -1705,6 +1721,18 @@ func (s *ExternalSourcesGenerationConfiguration) Validate() error { return nil } +// SetGuardrailConfiguration sets the GuardrailConfiguration field's value. +func (s *ExternalSourcesGenerationConfiguration) SetGuardrailConfiguration(v *GuardrailConfiguration) *ExternalSourcesGenerationConfiguration { + s.GuardrailConfiguration = v + return s +} + +// SetInferenceConfig sets the InferenceConfig field's value. +func (s *ExternalSourcesGenerationConfiguration) SetInferenceConfig(v *InferenceConfig) *ExternalSourcesGenerationConfiguration { + s.InferenceConfig = v + return s +} + // SetPromptTemplate sets the PromptTemplate field's value. func (s *ExternalSourcesGenerationConfiguration) SetPromptTemplate(v *PromptTemplate) *ExternalSourcesGenerationConfiguration { s.PromptTemplate = v @@ -1892,7 +1920,7 @@ func (s *FinalResponse) SetText(v string) *FinalResponse { // // This data type is used in the following API operations: // -// - In the returnControl field of the Retrieve response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax) +// - In the returnControl field of the InvokeAgent response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax) type FunctionInvocationInput_ struct { _ struct{} `type:"structure"` @@ -1948,7 +1976,7 @@ func (s *FunctionInvocationInput_) SetParameters(v []*FunctionParameter) *Functi // // This data type is used in the following API operations: // -// - In the returnControl field of the Retrieve response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax) +// - In the returnControl field of the InvokeAgent response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax) type FunctionParameter struct { _ struct{} `type:"structure"` @@ -2003,7 +2031,7 @@ func (s *FunctionParameter) SetValue(v string) *FunctionParameter { // // This data type is used in the following API operations: // -// - In the returnControlInvocationResults of the Retrieve request (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax) +// - In the returnControlInvocationResults of the InvokeAgent request (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_RequestSyntax) type FunctionResult struct { _ struct{} `type:"structure"` @@ -2015,8 +2043,9 @@ type FunctionResult struct { // The name of the function that was called. Function *string `locationName:"function" type:"string"` - // The response from the function call using the parameters. The response may - // be returned directly or from the Lambda function. + // The response from the function call using the parameters. The key of the + // object is the content type (currently, only TEXT is supported). The response + // may be returned directly or from the Lambda function. ResponseBody map[string]*ContentBody `locationName:"responseBody" type:"map"` // Controls the final response state returned to end user when API/Function @@ -2086,7 +2115,7 @@ func (s *FunctionResult) SetResponseState(v string) *FunctionResult { // // This data type is used in the following API operations: // -// - Retrieve response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax) +// - InvokeAgent response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax) // – in the generatedResponsePart field // // - RetrieveAndGenerate response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax) @@ -2136,6 +2165,13 @@ func (s *GeneratedResponsePart) SetTextResponsePart(v *TextResponsePart) *Genera type GenerationConfiguration struct { _ struct{} `type:"structure"` + // The configuration details for the guardrail. + GuardrailConfiguration *GuardrailConfiguration `locationName:"guardrailConfiguration" type:"structure"` + + // Configuration settings for inference when using RetrieveAndGenerate to generate + // responses while using a knowledge base as a source. + InferenceConfig *InferenceConfig `locationName:"inferenceConfig" type:"structure"` + // Contains the template for the prompt that's sent to the model for response // generation. PromptTemplate *PromptTemplate `locationName:"promptTemplate" type:"structure"` @@ -2162,6 +2198,11 @@ func (s GenerationConfiguration) GoString() string { // Validate inspects the fields of the type to determine if they are valid. func (s *GenerationConfiguration) Validate() error { invalidParams := request.ErrInvalidParams{Context: "GenerationConfiguration"} + if s.GuardrailConfiguration != nil { + if err := s.GuardrailConfiguration.Validate(); err != nil { + invalidParams.AddNested("GuardrailConfiguration", err.(request.ErrInvalidParams)) + } + } if s.PromptTemplate != nil { if err := s.PromptTemplate.Validate(); err != nil { invalidParams.AddNested("PromptTemplate", err.(request.ErrInvalidParams)) @@ -2174,12 +2215,122 @@ func (s *GenerationConfiguration) Validate() error { return nil } +// SetGuardrailConfiguration sets the GuardrailConfiguration field's value. +func (s *GenerationConfiguration) SetGuardrailConfiguration(v *GuardrailConfiguration) *GenerationConfiguration { + s.GuardrailConfiguration = v + return s +} + +// SetInferenceConfig sets the InferenceConfig field's value. +func (s *GenerationConfiguration) SetInferenceConfig(v *InferenceConfig) *GenerationConfiguration { + s.InferenceConfig = v + return s +} + // SetPromptTemplate sets the PromptTemplate field's value. func (s *GenerationConfiguration) SetPromptTemplate(v *PromptTemplate) *GenerationConfiguration { s.PromptTemplate = v return s } +// The configuration details for the guardrail. +type GuardrailConfiguration struct { + _ struct{} `type:"structure"` + + // The unique identifier for the guardrail. + // + // GuardrailId is a required field + GuardrailId *string `locationName:"guardrailId" type:"string" required:"true"` + + // The version of the guardrail. + // + // GuardrailVersion is a required field + GuardrailVersion *string `locationName:"guardrailVersion" min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GuardrailConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GuardrailConfiguration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *GuardrailConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GuardrailConfiguration"} + if s.GuardrailId == nil { + invalidParams.Add(request.NewErrParamRequired("GuardrailId")) + } + if s.GuardrailVersion == nil { + invalidParams.Add(request.NewErrParamRequired("GuardrailVersion")) + } + if s.GuardrailVersion != nil && len(*s.GuardrailVersion) < 1 { + invalidParams.Add(request.NewErrParamMinLen("GuardrailVersion", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetGuardrailId sets the GuardrailId field's value. +func (s *GuardrailConfiguration) SetGuardrailId(v string) *GuardrailConfiguration { + s.GuardrailId = &v + return s +} + +// SetGuardrailVersion sets the GuardrailVersion field's value. +func (s *GuardrailConfiguration) SetGuardrailVersion(v string) *GuardrailConfiguration { + s.GuardrailVersion = &v + return s +} + +// The configuration for inference settings when generating responses using +// RetrieveAndGenerate. +type InferenceConfig struct { + _ struct{} `type:"structure"` + + // Configuration settings specific to text generation while generating responses + // using RetrieveAndGenerate. + TextInferenceConfig *TextInferenceConfig `locationName:"textInferenceConfig" type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s InferenceConfig) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s InferenceConfig) GoString() string { + return s.String() +} + +// SetTextInferenceConfig sets the TextInferenceConfig field's value. +func (s *InferenceConfig) SetTextInferenceConfig(v *TextInferenceConfig) *InferenceConfig { + s.TextInferenceConfig = v + return s +} + // Specifications about the inference parameters that were provided alongside // the prompt. These are specified in the PromptOverrideConfiguration (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html) // object that was set when the agent was created or updated. For more information, @@ -2362,7 +2513,7 @@ func (s *InternalServerException) RequestID() string { // // This data type is used in the following API operations: // -// - In the returnControl field of the Retrieve response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax) +// - In the returnControl field of the InvokeAgent response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax) type InvocationInputMember struct { _ struct{} `type:"structure"` @@ -2466,11 +2617,13 @@ func (s *InvocationInput_) SetTraceId(v string) *InvocationInput_ { return s } -// A result from the action group invocation. +// A result from the invocation of an action. For more information, see Return +// control to the agent developer (https://docs.aws.amazon.com/bedrock/latest/userguide/agents-returncontrol.html) +// and Control session context (https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html). // // This data type is used in the following API operations: // -// - Retrieve request (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax) +// - InvokeAgent request (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_RequestSyntax) type InvocationResultMember struct { _ struct{} `type:"structure"` @@ -2553,6 +2706,9 @@ type InvokeAgentInput struct { // The prompt text to send the agent. // + // If you include returnControlInvocationResults in the sessionState field, + // the inputText field will be ignored. + // // InputText is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by InvokeAgentInput's // String and GoString methods. @@ -2566,6 +2722,9 @@ type InvokeAgentInput struct { // Contains parameters that specify various attributes of the session. For more // information, see Control session context (https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html). + // + // If you include returnControlInvocationResults in the sessionState field, + // the inputText field will be ignored. SessionState *SessionState `locationName:"sessionState" type:"structure"` } @@ -4462,7 +4621,7 @@ func (s *RetrievalFilter) SetOrAll(v []*RetrievalFilter) *RetrievalFilter { // - RetrieveAndGenerate response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax) // – in the content field // -// - Retrieve response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax) +// - InvokeAgent response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax) // – in the content field type RetrievalResultContent struct { _ struct{} `type:"structure" sensitive:"true"` @@ -4507,7 +4666,7 @@ func (s *RetrievalResultContent) SetText(v string) *RetrievalResultContent { // - RetrieveAndGenerate response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax) // – in the location field // -// - Retrieve response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax) +// - InvokeAgent response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax) // – in the locatino field type RetrievalResultLocation struct { _ struct{} `type:"structure" sensitive:"true"` @@ -4561,7 +4720,7 @@ func (s *RetrievalResultLocation) SetType(v string) *RetrievalResultLocation { // - RetrieveAndGenerate response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax) // – in the s3Location field // -// - Retrieve response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax) +// - InvokeAgent response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax) // – in the s3Location field type RetrievalResultS3Location struct { _ struct{} `type:"structure"` @@ -4831,6 +4990,9 @@ type RetrieveAndGenerateOutput struct { // the knowledge base, alongside information about the sources. Citations []*Citation `locationName:"citations" type:"list"` + // Specifies if there is a guardrail intervention in the response. + GuardrailAction *string `locationName:"guardrailAction" type:"string" enum:"GuadrailAction"` + // Contains the response generated from querying the knowledge base. // // Output is a sensitive parameter and its value will be @@ -4871,6 +5033,12 @@ func (s *RetrieveAndGenerateOutput) SetCitations(v []*Citation) *RetrieveAndGene return s } +// SetGuardrailAction sets the GuardrailAction field's value. +func (s *RetrieveAndGenerateOutput) SetGuardrailAction(v string) *RetrieveAndGenerateOutput { + s.GuardrailAction = &v + return s +} + // SetOutput sets the Output field's value. func (s *RetrieveAndGenerateOutput) SetOutput(v *RetrieveAndGenerateOutput_) *RetrieveAndGenerateOutput { s.Output = v @@ -5133,7 +5301,7 @@ func (s *RetrieveOutput) SetRetrievalResults(v []*KnowledgeBaseRetrievalResult) // - RetrieveAndGenerate response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax) // – in the retrievedReferences field // -// - Retrieve response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax) +// - InvokeAgent response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax) // – in the retrievedReferences field type RetrievedReference struct { _ struct{} `type:"structure"` @@ -5188,7 +5356,7 @@ func (s *RetrievedReference) SetLocation(v *RetrievalResultLocation) *RetrievedR // // This data type is used in the following API operations: // -// - Retrieve response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax) +// - InvokeAgent response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax) type ReturnControlPayload struct { _ struct{} `type:"structure" sensitive:"true"` @@ -5413,7 +5581,11 @@ func (s *ServiceQuotaExceededException) RequestID() string { type SessionState struct { _ struct{} `type:"structure"` - // The identifier of the invocation. + // The identifier of the invocation of an action. This value must match the + // invocationId returned in the InvokeAgent response for the action whose results + // are provided in the returnControlInvocationResults field. For more information, + // see Return control to the agent developer (https://docs.aws.amazon.com/bedrock/latest/userguide/agents-returncontrol.html) + // and Control session context (https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html). InvocationId *string `locationName:"invocationId" type:"string"` // Contains attributes that persist across a prompt and the values of those @@ -5423,6 +5595,10 @@ type SessionState struct { PromptSessionAttributes map[string]*string `locationName:"promptSessionAttributes" type:"map"` // Contains information about the results from the action group invocation. + // For more information, see Return control to the agent developer (https://docs.aws.amazon.com/bedrock/latest/userguide/agents-returncontrol.html) + // and Control session context (https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html). + // + // If you include this field, the inputText field will be ignored. ReturnControlInvocationResults []*InvocationResultMember `locationName:"returnControlInvocationResults" min:"1" type:"list"` // Contains attributes that persist across a session and the values of those @@ -5503,7 +5679,7 @@ func (s *SessionState) SetSessionAttributes(v map[string]*string) *SessionState // - RetrieveAndGenerate response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax) // – in the span field // -// - Retrieve response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax) +// - InvokeAgent response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax) // – in the span field type Span struct { _ struct{} `type:"structure"` @@ -5545,6 +5721,83 @@ func (s *Span) SetStart(v int64) *Span { return s } +// Configuration settings for text generation using a language model via the +// RetrieveAndGenerate operation. Includes parameters like temperature, top-p, +// maximum token count, and stop sequences. +// +// The valid range of maxTokens depends on the accepted values for your chosen +// model's inference parameters. To see the inference parameters for your model, +// see Inference parameters for foundation models. (https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html) +type TextInferenceConfig struct { + _ struct{} `type:"structure"` + + // The maximum number of tokens to generate in the output text. Do not use the + // minimum of 0 or the maximum of 65536. The limit values described here are + // arbitary values, for actual values consult the limits defined by your specific + // model. + MaxTokens *int64 `locationName:"maxTokens" type:"integer"` + + // A list of sequences of characters that, if generated, will cause the model + // to stop generating further tokens. Do not use a minimum length of 1 or a + // maximum length of 1000. The limit values described here are arbitary values, + // for actual values consult the limits defined by your specific model. + StopSequences []*string `locationName:"stopSequences" type:"list"` + + // Controls the random-ness of text generated by the language model, influencing + // how much the model sticks to the most predictable next words versus exploring + // more surprising options. A lower temperature value (e.g. 0.2 or 0.3) makes + // model outputs more deterministic or predictable, while a higher temperature + // (e.g. 0.8 or 0.9) makes the outputs more creative or unpredictable. + Temperature *float64 `locationName:"temperature" type:"float"` + + // A probability distribution threshold which controls what the model considers + // for the set of possible next tokens. The model will only consider the top + // p% of the probability distribution when generating the next token. + TopP *float64 `locationName:"topP" type:"float"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s TextInferenceConfig) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s TextInferenceConfig) GoString() string { + return s.String() +} + +// SetMaxTokens sets the MaxTokens field's value. +func (s *TextInferenceConfig) SetMaxTokens(v int64) *TextInferenceConfig { + s.MaxTokens = &v + return s +} + +// SetStopSequences sets the StopSequences field's value. +func (s *TextInferenceConfig) SetStopSequences(v []*string) *TextInferenceConfig { + s.StopSequences = v + return s +} + +// SetTemperature sets the Temperature field's value. +func (s *TextInferenceConfig) SetTemperature(v float64) *TextInferenceConfig { + s.Temperature = &v + return s +} + +// SetTopP sets the TopP field's value. +func (s *TextInferenceConfig) SetTopP(v float64) *TextInferenceConfig { + s.TopP = &v + return s +} + // Contains the part of the generated text that contains a citation, alongside // where it begins and ends. // @@ -5553,7 +5806,7 @@ func (s *Span) SetStart(v int64) *Span { // - RetrieveAndGenerate response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax) // – in the textResponsePart field // -// - Retrieve response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax) +// - InvokeAgent response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax) // – in the textResponsePart field type TextResponsePart struct { _ struct{} `type:"structure" sensitive:"true"` @@ -6002,6 +6255,22 @@ func ExternalSourceType_Values() []string { } } +const ( + // GuadrailActionIntervened is a GuadrailAction enum value + GuadrailActionIntervened = "INTERVENED" + + // GuadrailActionNone is a GuadrailAction enum value + GuadrailActionNone = "NONE" +) + +// GuadrailAction_Values returns all elements of the GuadrailAction enum +func GuadrailAction_Values() []string { + return []string{ + GuadrailActionIntervened, + GuadrailActionNone, + } +} + const ( // InvocationTypeActionGroup is a InvocationType enum value InvocationTypeActionGroup = "ACTION_GROUP" diff --git a/service/pinpoint/api.go b/service/pinpoint/api.go index e1316f60ad4..9948ae4ce97 100644 --- a/service/pinpoint/api.go +++ b/service/pinpoint/api.go @@ -15310,6 +15310,10 @@ type CampaignEmailMessage struct { // the FromAddress specified for the email channel for the application. FromAddress *string `type:"string"` + // The list of MessageHeaders (https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-campaigns-campaign-id.html#apps-application-id-campaigns-campaign-id-model-messageheader) + // for the email. You can have up to 15 MessageHeaders for each email. + Headers []*MessageHeader `type:"list"` + // The body of the email, in HTML format, for recipients whose email clients // render HTML content. HtmlBody *string `type:"string"` @@ -15348,6 +15352,12 @@ func (s *CampaignEmailMessage) SetFromAddress(v string) *CampaignEmailMessage { return s } +// SetHeaders sets the Headers field's value. +func (s *CampaignEmailMessage) SetHeaders(v []*MessageHeader) *CampaignEmailMessage { + s.Headers = v + return s +} + // SetHtmlBody sets the HtmlBody field's value. func (s *CampaignEmailMessage) SetHtmlBody(v string) *CampaignEmailMessage { s.HtmlBody = &v @@ -21109,6 +21119,10 @@ type EmailTemplateRequest struct { // address-specific variables and values. DefaultSubstitutions *string `type:"string"` + // The list of MessageHeaders (https://docs.aws.amazon.com/pinpoint/latest/apireference/templates-template-name-email.html#templates-template-name-email-model-messageheader) + // for the email. You can have up to 15 Headers. + Headers []*MessageHeader `type:"list"` + // The message body, in HTML format, to use in email messages that are based // on the message template. We recommend using HTML format for email clients // that render HTML content. You can include links, formatted text, and more @@ -21172,6 +21186,12 @@ func (s *EmailTemplateRequest) SetDefaultSubstitutions(v string) *EmailTemplateR return s } +// SetHeaders sets the Headers field's value. +func (s *EmailTemplateRequest) SetHeaders(v []*MessageHeader) *EmailTemplateRequest { + s.Headers = v + return s +} + // SetHtmlPart sets the HtmlPart field's value. func (s *EmailTemplateRequest) SetHtmlPart(v string) *EmailTemplateRequest { s.HtmlPart = &v @@ -21227,6 +21247,8 @@ type EmailTemplateResponse struct { // defines the default value for that variable. DefaultSubstitutions *string `type:"string"` + Headers []*MessageHeader `type:"list"` + // The message body, in HTML format, that's used in email messages that are // based on the message template. HtmlPart *string `type:"string"` @@ -21309,6 +21331,12 @@ func (s *EmailTemplateResponse) SetDefaultSubstitutions(v string) *EmailTemplate return s } +// SetHeaders sets the Headers field's value. +func (s *EmailTemplateResponse) SetHeaders(v []*MessageHeader) *EmailTemplateResponse { + s.Headers = v + return s +} + // SetHtmlPart sets the HtmlPart field's value. func (s *EmailTemplateResponse) SetHtmlPart(v string) *EmailTemplateResponse { s.HtmlPart = &v @@ -32549,6 +32577,52 @@ func (s *MessageConfiguration) SetSMSMessage(v *CampaignSmsMessage) *MessageConf return s } +// Contains the name and value pair of an email header to add to your email. +// You can have up to 15 MessageHeaders. A header can contain information such +// as the sender, receiver, route, or timestamp. +type MessageHeader struct { + _ struct{} `type:"structure"` + + // The name of the message header. The header name can contain up to 126 characters. + Name *string `type:"string"` + + // The value of the message header. The header value can contain up to 870 characters, + // including the length of any rendered attributes. For example if you add the + // {CreationDate} attribute, it renders as YYYY-MM-DDTHH:MM:SS.SSSZ and is 24 + // characters in length. + Value *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s MessageHeader) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s MessageHeader) GoString() string { + return s.String() +} + +// SetName sets the Name field's value. +func (s *MessageHeader) SetName(v string) *MessageHeader { + s.Name = &v + return s +} + +// SetValue sets the Value field's value. +func (s *MessageHeader) SetValue(v string) *MessageHeader { + s.Value = &v + return s +} + // Specifies the configuration and other settings for a message. type MessageRequest struct { _ struct{} `type:"structure"` @@ -37538,6 +37612,9 @@ func (s *SimpleCondition) SetSegmentDimensions(v *SegmentDimensions) *SimpleCond type SimpleEmail struct { _ struct{} `type:"structure"` + // List of Headers for the email. + Headers []*MessageHeader `type:"list"` + // The body of the email message, in HTML format. We recommend using HTML format // for email clients that render HTML content. You can include links, formatted // text, and more in an HTML message. @@ -37570,6 +37647,12 @@ func (s SimpleEmail) GoString() string { return s.String() } +// SetHeaders sets the Headers field's value. +func (s *SimpleEmail) SetHeaders(v []*MessageHeader) *SimpleEmail { + s.Headers = v + return s +} + // SetHtmlPart sets the HtmlPart field's value. func (s *SimpleEmail) SetHtmlPart(v *SimpleEmailPart) *SimpleEmail { s.HtmlPart = v diff --git a/service/route53resolver/api.go b/service/route53resolver/api.go index a944b9b795f..2a8b317b09e 100644 --- a/service/route53resolver/api.go +++ b/service/route53resolver/api.go @@ -8589,15 +8589,15 @@ type CreateFirewallRuleInput struct { FirewallDomainListId *string `min:"1" type:"string" required:"true"` // How you want the the rule to evaluate DNS redirection in the DNS redirection - // chain, such as CNAME, DNAME, ot ALIAS. + // chain, such as CNAME or DNAME. // // Inspect_Redirection_Domain (Default) inspects all domains in the redirection // chain. The individual domains in the redirection chain must be added to the - // allow domain list. + // domain list. // // Trust_Redirection_Domain inspects only the first domain in the redirection - // chain. You don't need to add the subsequent domains in the redirection list - // to the domain alloww list. + // chain. You don't need to add the subsequent domains in the domain in the + // redirection list to the domain list. FirewallDomainRedirectionAction *string `type:"string" enum:"FirewallDomainRedirectionAction"` // The unique identifier of the firewall rule group where you want to create @@ -11127,15 +11127,15 @@ type FirewallRule struct { FirewallDomainListId *string `min:"1" type:"string"` // How you want the the rule to evaluate DNS redirection in the DNS redirection - // chain, such as CNAME, DNAME, ot ALIAS. + // chain, such as CNAME or DNAME. // // Inspect_Redirection_Domain (Default) inspects all domains in the redirection // chain. The individual domains in the redirection chain must be added to the - // allow domain list. + // domain list. // // Trust_Redirection_Domain inspects only the first domain in the redirection // chain. You don't need to add the subsequent domains in the domain in the - // redirection list to the domain alloww list. + // redirection list to the domain list. FirewallDomainRedirectionAction *string `type:"string" enum:"FirewallDomainRedirectionAction"` // The unique identifier of the firewall rule group of the rule. @@ -18632,15 +18632,15 @@ type UpdateFirewallRuleInput struct { FirewallDomainListId *string `min:"1" type:"string" required:"true"` // How you want the the rule to evaluate DNS redirection in the DNS redirection - // chain, such as CNAME, DNAME, ot ALIAS. + // chain, such as CNAME or DNAME. // // Inspect_Redirection_Domain (Default) inspects all domains in the redirection // chain. The individual domains in the redirection chain must be added to the - // allow domain list. + // domain list. // // Trust_Redirection_Domain inspects only the first domain in the redirection // chain. You don't need to add the subsequent domains in the domain in the - // redirection list to the domain alloww list. + // redirection list to the domain list. FirewallDomainRedirectionAction *string `type:"string" enum:"FirewallDomainRedirectionAction"` // The unique identifier of the firewall rule group for the rule. diff --git a/service/ssmsap/api.go b/service/ssmsap/api.go index a48b072d70e..7b7d489ecad 100644 --- a/service/ssmsap/api.go +++ b/service/ssmsap/api.go @@ -1034,6 +1034,148 @@ func (c *SsmSap) ListDatabasesPagesWithContext(ctx aws.Context, input *ListDatab return p.Err() } +const opListOperationEvents = "ListOperationEvents" + +// ListOperationEventsRequest generates a "aws/request.Request" representing the +// client's request for the ListOperationEvents operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListOperationEvents for more information on using the ListOperationEvents +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the ListOperationEventsRequest method. +// req, resp := client.ListOperationEventsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-sap-2018-05-10/ListOperationEvents +func (c *SsmSap) ListOperationEventsRequest(input *ListOperationEventsInput) (req *request.Request, output *ListOperationEventsOutput) { + op := &request.Operation{ + Name: opListOperationEvents, + HTTPMethod: "POST", + HTTPPath: "/list-operation-events", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListOperationEventsInput{} + } + + output = &ListOperationEventsOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListOperationEvents API operation for AWS Systems Manager for SAP. +// +// Returns a list of operations events. +// +// Available parameters include OperationID, as well as optional parameters +// MaxResults, NextToken, and Filters. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Systems Manager for SAP's +// API operation ListOperationEvents for usage and error information. +// +// Returned Error Types: +// +// - ValidationException +// The input fails to satisfy the constraints specified by an AWS service. +// +// - InternalServerException +// An internal error has occurred. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-sap-2018-05-10/ListOperationEvents +func (c *SsmSap) ListOperationEvents(input *ListOperationEventsInput) (*ListOperationEventsOutput, error) { + req, out := c.ListOperationEventsRequest(input) + return out, req.Send() +} + +// ListOperationEventsWithContext is the same as ListOperationEvents with the addition of +// the ability to pass a context and additional request options. +// +// See ListOperationEvents for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *SsmSap) ListOperationEventsWithContext(ctx aws.Context, input *ListOperationEventsInput, opts ...request.Option) (*ListOperationEventsOutput, error) { + req, out := c.ListOperationEventsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListOperationEventsPages iterates over the pages of a ListOperationEvents operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListOperationEvents method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListOperationEvents operation. +// pageNum := 0 +// err := client.ListOperationEventsPages(params, +// func(page *ssmsap.ListOperationEventsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +func (c *SsmSap) ListOperationEventsPages(input *ListOperationEventsInput, fn func(*ListOperationEventsOutput, bool) bool) error { + return c.ListOperationEventsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListOperationEventsPagesWithContext same as ListOperationEventsPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *SsmSap) ListOperationEventsPagesWithContext(ctx aws.Context, input *ListOperationEventsInput, fn func(*ListOperationEventsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListOperationEventsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListOperationEventsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListOperationEventsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + const opListOperations = "ListOperations" // ListOperationsRequest generates a "aws/request.Request" representing the @@ -1442,6 +1584,96 @@ func (c *SsmSap) RegisterApplicationWithContext(ctx aws.Context, input *Register return out, req.Send() } +const opStartApplication = "StartApplication" + +// StartApplicationRequest generates a "aws/request.Request" representing the +// client's request for the StartApplication operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See StartApplication for more information on using the StartApplication +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the StartApplicationRequest method. +// req, resp := client.StartApplicationRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-sap-2018-05-10/StartApplication +func (c *SsmSap) StartApplicationRequest(input *StartApplicationInput) (req *request.Request, output *StartApplicationOutput) { + op := &request.Operation{ + Name: opStartApplication, + HTTPMethod: "POST", + HTTPPath: "/start-application", + } + + if input == nil { + input = &StartApplicationInput{} + } + + output = &StartApplicationOutput{} + req = c.newRequest(op, input, output) + return +} + +// StartApplication API operation for AWS Systems Manager for SAP. +// +// Request is an operation which starts an application. +// +// Parameter ApplicationId is required. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Systems Manager for SAP's +// API operation StartApplication for usage and error information. +// +// Returned Error Types: +// +// - ResourceNotFoundException +// The resource is not available. +// +// - ValidationException +// The input fails to satisfy the constraints specified by an AWS service. +// +// - ConflictException +// A conflict has occurred. +// +// - InternalServerException +// An internal error has occurred. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-sap-2018-05-10/StartApplication +func (c *SsmSap) StartApplication(input *StartApplicationInput) (*StartApplicationOutput, error) { + req, out := c.StartApplicationRequest(input) + return out, req.Send() +} + +// StartApplicationWithContext is the same as StartApplication with the addition of +// the ability to pass a context and additional request options. +// +// See StartApplication for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *SsmSap) StartApplicationWithContext(ctx aws.Context, input *StartApplicationInput, opts ...request.Option) (*StartApplicationOutput, error) { + req, out := c.StartApplicationRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opStartApplicationRefresh = "StartApplicationRefresh" // StartApplicationRefreshRequest generates a "aws/request.Request" representing the @@ -1533,6 +1765,97 @@ func (c *SsmSap) StartApplicationRefreshWithContext(ctx aws.Context, input *Star return out, req.Send() } +const opStopApplication = "StopApplication" + +// StopApplicationRequest generates a "aws/request.Request" representing the +// client's request for the StopApplication operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See StopApplication for more information on using the StopApplication +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the StopApplicationRequest method. +// req, resp := client.StopApplicationRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-sap-2018-05-10/StopApplication +func (c *SsmSap) StopApplicationRequest(input *StopApplicationInput) (req *request.Request, output *StopApplicationOutput) { + op := &request.Operation{ + Name: opStopApplication, + HTTPMethod: "POST", + HTTPPath: "/stop-application", + } + + if input == nil { + input = &StopApplicationInput{} + } + + output = &StopApplicationOutput{} + req = c.newRequest(op, input, output) + return +} + +// StopApplication API operation for AWS Systems Manager for SAP. +// +// Request is an operation to stop an application. +// +// Parameter ApplicationId is required. Parameters StopConnectedEntity and IncludeEc2InstanceShutdown +// are optional. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Systems Manager for SAP's +// API operation StopApplication for usage and error information. +// +// Returned Error Types: +// +// - ResourceNotFoundException +// The resource is not available. +// +// - ValidationException +// The input fails to satisfy the constraints specified by an AWS service. +// +// - ConflictException +// A conflict has occurred. +// +// - InternalServerException +// An internal error has occurred. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-sap-2018-05-10/StopApplication +func (c *SsmSap) StopApplication(input *StopApplicationInput) (*StopApplicationOutput, error) { + req, out := c.StopApplicationRequest(input) + return out, req.Send() +} + +// StopApplicationWithContext is the same as StopApplication with the addition of +// the ability to pass a context and additional request options. +// +// See StopApplication for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *SsmSap) StopApplicationWithContext(ctx aws.Context, input *StopApplicationInput, opts ...request.Option) (*StopApplicationOutput, error) { + req, out := c.StopApplicationRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opTagResource = "TagResource" // TagResourceRequest generates a "aws/request.Request" representing the @@ -4011,24 +4334,162 @@ func (s *ListDatabasesOutput) SetNextToken(v string) *ListDatabasesOutput { return s } -type ListOperationsInput struct { +type ListOperationEventsInput struct { _ struct{} `type:"structure"` - // The ID of the application. + // Optionally specify filters to narrow the returned operation event items. // - // ApplicationId is a required field - ApplicationId *string `type:"string" required:"true"` - - // The filters of an operation. + // Valid filter names include status, resourceID, and resourceType. The valid + // operator for all three filters is Equals. Filters []*Filter `min:"1" type:"list"` // The maximum number of results to return with a single call. To retrieve the - // remaining results, make another call with the returned nextToken value. If - // you do not specify a value for MaxResults, the request returns 50 items per - // page by default. + // remaining results, make another call with the returned nextToken value. + // + // If you do not specify a value for MaxResults, the request returns 50 items + // per page by default. MaxResults *int64 `min:"1" type:"integer"` - // The token for the next page of results. + // The token to use to retrieve the next page of results. This value is null + // when there are no more results to return. + NextToken *string `type:"string"` + + // The ID of the operation. + // + // OperationId is a required field + OperationId *string `type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListOperationEventsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListOperationEventsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListOperationEventsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListOperationEventsInput"} + if s.Filters != nil && len(s.Filters) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Filters", 1)) + } + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + if s.OperationId == nil { + invalidParams.Add(request.NewErrParamRequired("OperationId")) + } + if s.Filters != nil { + for i, v := range s.Filters { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Filters", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetFilters sets the Filters field's value. +func (s *ListOperationEventsInput) SetFilters(v []*Filter) *ListOperationEventsInput { + s.Filters = v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListOperationEventsInput) SetMaxResults(v int64) *ListOperationEventsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListOperationEventsInput) SetNextToken(v string) *ListOperationEventsInput { + s.NextToken = &v + return s +} + +// SetOperationId sets the OperationId field's value. +func (s *ListOperationEventsInput) SetOperationId(v string) *ListOperationEventsInput { + s.OperationId = &v + return s +} + +type ListOperationEventsOutput struct { + _ struct{} `type:"structure"` + + // The token to use to retrieve the next page of results. This value is null + // when there are no more results to return. + NextToken *string `type:"string"` + + // A returned list of operation events that meet the filter criteria. + OperationEvents []*OperationEvent `type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListOperationEventsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListOperationEventsOutput) GoString() string { + return s.String() +} + +// SetNextToken sets the NextToken field's value. +func (s *ListOperationEventsOutput) SetNextToken(v string) *ListOperationEventsOutput { + s.NextToken = &v + return s +} + +// SetOperationEvents sets the OperationEvents field's value. +func (s *ListOperationEventsOutput) SetOperationEvents(v []*OperationEvent) *ListOperationEventsOutput { + s.OperationEvents = v + return s +} + +type ListOperationsInput struct { + _ struct{} `type:"structure"` + + // The ID of the application. + // + // ApplicationId is a required field + ApplicationId *string `type:"string" required:"true"` + + // The filters of an operation. + Filters []*Filter `min:"1" type:"list"` + + // The maximum number of results to return with a single call. To retrieve the + // remaining results, make another call with the returned nextToken value. If + // you do not specify a value for MaxResults, the request returns 50 items per + // page by default. + MaxResults *int64 `min:"1" type:"integer"` + + // The token for the next page of results. NextToken *string `type:"string"` } @@ -4345,6 +4806,93 @@ func (s *Operation) SetType(v string) *Operation { return s } +// An operation event returns details for an operation, including key milestones +// which can be used to monitor and track operations in progress. +// +// Operation events contain: +// +// - Description string +// +// - Resource, including its ARN and type +// +// - Status +// +// - StatusMessage string +// +// - TimeStamp +// +// Operation event examples include StartApplication or StopApplication. +type OperationEvent struct { + _ struct{} `type:"structure"` + + // A description of the operation event. For example, "Stop the EC2 instance + // i-abcdefgh987654321". + Description *string `type:"string"` + + // The resource involved in the operations event. + // + // Contains ResourceArn ARN and ResourceType. + Resource *Resource `type:"structure"` + + // The status of the operation event. The possible statuses are: IN_PROGRESS, + // COMPLETED, and FAILED. + Status *string `type:"string" enum:"OperationEventStatus"` + + // The status message relating to a specific operation event. + StatusMessage *string `type:"string"` + + // The timestamp of the specified operation event. + Timestamp *time.Time `type:"timestamp"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s OperationEvent) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s OperationEvent) GoString() string { + return s.String() +} + +// SetDescription sets the Description field's value. +func (s *OperationEvent) SetDescription(v string) *OperationEvent { + s.Description = &v + return s +} + +// SetResource sets the Resource field's value. +func (s *OperationEvent) SetResource(v *Resource) *OperationEvent { + s.Resource = v + return s +} + +// SetStatus sets the Status field's value. +func (s *OperationEvent) SetStatus(v string) *OperationEvent { + s.Status = &v + return s +} + +// SetStatusMessage sets the StatusMessage field's value. +func (s *OperationEvent) SetStatusMessage(v string) *OperationEvent { + s.StatusMessage = &v + return s +} + +// SetTimestamp sets the Timestamp field's value. +func (s *OperationEvent) SetTimestamp(v time.Time) *OperationEvent { + s.Timestamp = &v + return s +} + type PutResourcePermissionInput struct { _ struct{} `type:"structure"` @@ -4683,6 +5231,51 @@ func (s *Resilience) SetHsrTier(v string) *Resilience { return s } +// The resource contains a ResourceArn and the ResourceType. +type Resource struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the source resource. + // + // Example of ResourceArn: "arn:aws:ec2:us-east-1:111111111111:instance/i-abcdefgh987654321" + ResourceArn *string `type:"string"` + + // The resource type. + // + // Example of ResourceType: "AWS::SystemsManagerSAP::Component" or "AWS::EC2::Instance". + ResourceType *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Resource) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Resource) GoString() string { + return s.String() +} + +// SetResourceArn sets the ResourceArn field's value. +func (s *Resource) SetResourceArn(v string) *Resource { + s.ResourceArn = &v + return s +} + +// SetResourceType sets the ResourceType field's value. +func (s *Resource) SetResourceType(v string) *Resource { + s.ResourceType = &v + return s +} + // The resource is not available. type ResourceNotFoundException struct { _ struct{} `type:"structure"` @@ -4747,6 +5340,83 @@ func (s *ResourceNotFoundException) RequestID() string { return s.RespMetadata.RequestID } +type StartApplicationInput struct { + _ struct{} `type:"structure"` + + // The ID of the application. + // + // ApplicationId is a required field + ApplicationId *string `type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StartApplicationInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StartApplicationInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *StartApplicationInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "StartApplicationInput"} + if s.ApplicationId == nil { + invalidParams.Add(request.NewErrParamRequired("ApplicationId")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetApplicationId sets the ApplicationId field's value. +func (s *StartApplicationInput) SetApplicationId(v string) *StartApplicationInput { + s.ApplicationId = &v + return s +} + +type StartApplicationOutput struct { + _ struct{} `type:"structure"` + + // The ID of the operation. + OperationId *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StartApplicationOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StartApplicationOutput) GoString() string { + return s.String() +} + +// SetOperationId sets the OperationId field's value. +func (s *StartApplicationOutput) SetOperationId(v string) *StartApplicationOutput { + s.OperationId = &v + return s +} + type StartApplicationRefreshInput struct { _ struct{} `type:"structure"` @@ -4824,6 +5494,105 @@ func (s *StartApplicationRefreshOutput) SetOperationId(v string) *StartApplicati return s } +type StopApplicationInput struct { + _ struct{} `type:"structure"` + + // The ID of the application. + // + // ApplicationId is a required field + ApplicationId *string `type:"string" required:"true"` + + // Boolean. If included and if set to True, the StopApplication operation will + // shut down the associated Amazon EC2 instance in addition to the application. + IncludeEc2InstanceShutdown *bool `type:"boolean"` + + // Specify the ConnectedEntityType. Accepted type is DBMS. + // + // If this parameter is included, the connected DBMS (Database Management System) + // will be stopped. + StopConnectedEntity *string `type:"string" enum:"ConnectedEntityType"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StopApplicationInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StopApplicationInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *StopApplicationInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "StopApplicationInput"} + if s.ApplicationId == nil { + invalidParams.Add(request.NewErrParamRequired("ApplicationId")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetApplicationId sets the ApplicationId field's value. +func (s *StopApplicationInput) SetApplicationId(v string) *StopApplicationInput { + s.ApplicationId = &v + return s +} + +// SetIncludeEc2InstanceShutdown sets the IncludeEc2InstanceShutdown field's value. +func (s *StopApplicationInput) SetIncludeEc2InstanceShutdown(v bool) *StopApplicationInput { + s.IncludeEc2InstanceShutdown = &v + return s +} + +// SetStopConnectedEntity sets the StopConnectedEntity field's value. +func (s *StopApplicationInput) SetStopConnectedEntity(v string) *StopApplicationInput { + s.StopConnectedEntity = &v + return s +} + +type StopApplicationOutput struct { + _ struct{} `type:"structure"` + + // The ID of the operation. + OperationId *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StopApplicationOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StopApplicationOutput) GoString() string { + return s.String() +} + +// SetOperationId sets the OperationId field's value. +func (s *StopApplicationOutput) SetOperationId(v string) *StopApplicationOutput { + s.OperationId = &v + return s +} + type TagResourceInput struct { _ struct{} `type:"structure"` @@ -5495,6 +6264,18 @@ func ComponentType_Values() []string { } } +const ( + // ConnectedEntityTypeDbms is a ConnectedEntityType enum value + ConnectedEntityTypeDbms = "DBMS" +) + +// ConnectedEntityType_Values returns all elements of the ConnectedEntityType enum +func ConnectedEntityType_Values() []string { + return []string{ + ConnectedEntityTypeDbms, + } +} + const ( // CredentialTypeAdmin is a CredentialType enum value CredentialTypeAdmin = "ADMIN" @@ -5615,6 +6396,26 @@ func HostRole_Values() []string { } } +const ( + // OperationEventStatusInProgress is a OperationEventStatus enum value + OperationEventStatusInProgress = "IN_PROGRESS" + + // OperationEventStatusCompleted is a OperationEventStatus enum value + OperationEventStatusCompleted = "COMPLETED" + + // OperationEventStatusFailed is a OperationEventStatus enum value + OperationEventStatusFailed = "FAILED" +) + +// OperationEventStatus_Values returns all elements of the OperationEventStatus enum +func OperationEventStatus_Values() []string { + return []string{ + OperationEventStatusInProgress, + OperationEventStatusCompleted, + OperationEventStatusFailed, + } +} + const ( // OperationModePrimary is a OperationMode enum value OperationModePrimary = "PRIMARY" diff --git a/service/ssmsap/ssmsapiface/interface.go b/service/ssmsap/ssmsapiface/interface.go index 9b1e4af3bb1..ce67b2a0803 100644 --- a/service/ssmsap/ssmsapiface/interface.go +++ b/service/ssmsap/ssmsapiface/interface.go @@ -109,6 +109,13 @@ type SsmSapAPI interface { ListDatabasesPages(*ssmsap.ListDatabasesInput, func(*ssmsap.ListDatabasesOutput, bool) bool) error ListDatabasesPagesWithContext(aws.Context, *ssmsap.ListDatabasesInput, func(*ssmsap.ListDatabasesOutput, bool) bool, ...request.Option) error + ListOperationEvents(*ssmsap.ListOperationEventsInput) (*ssmsap.ListOperationEventsOutput, error) + ListOperationEventsWithContext(aws.Context, *ssmsap.ListOperationEventsInput, ...request.Option) (*ssmsap.ListOperationEventsOutput, error) + ListOperationEventsRequest(*ssmsap.ListOperationEventsInput) (*request.Request, *ssmsap.ListOperationEventsOutput) + + ListOperationEventsPages(*ssmsap.ListOperationEventsInput, func(*ssmsap.ListOperationEventsOutput, bool) bool) error + ListOperationEventsPagesWithContext(aws.Context, *ssmsap.ListOperationEventsInput, func(*ssmsap.ListOperationEventsOutput, bool) bool, ...request.Option) error + ListOperations(*ssmsap.ListOperationsInput) (*ssmsap.ListOperationsOutput, error) ListOperationsWithContext(aws.Context, *ssmsap.ListOperationsInput, ...request.Option) (*ssmsap.ListOperationsOutput, error) ListOperationsRequest(*ssmsap.ListOperationsInput) (*request.Request, *ssmsap.ListOperationsOutput) @@ -128,10 +135,18 @@ type SsmSapAPI interface { RegisterApplicationWithContext(aws.Context, *ssmsap.RegisterApplicationInput, ...request.Option) (*ssmsap.RegisterApplicationOutput, error) RegisterApplicationRequest(*ssmsap.RegisterApplicationInput) (*request.Request, *ssmsap.RegisterApplicationOutput) + StartApplication(*ssmsap.StartApplicationInput) (*ssmsap.StartApplicationOutput, error) + StartApplicationWithContext(aws.Context, *ssmsap.StartApplicationInput, ...request.Option) (*ssmsap.StartApplicationOutput, error) + StartApplicationRequest(*ssmsap.StartApplicationInput) (*request.Request, *ssmsap.StartApplicationOutput) + StartApplicationRefresh(*ssmsap.StartApplicationRefreshInput) (*ssmsap.StartApplicationRefreshOutput, error) StartApplicationRefreshWithContext(aws.Context, *ssmsap.StartApplicationRefreshInput, ...request.Option) (*ssmsap.StartApplicationRefreshOutput, error) StartApplicationRefreshRequest(*ssmsap.StartApplicationRefreshInput) (*request.Request, *ssmsap.StartApplicationRefreshOutput) + StopApplication(*ssmsap.StopApplicationInput) (*ssmsap.StopApplicationOutput, error) + StopApplicationWithContext(aws.Context, *ssmsap.StopApplicationInput, ...request.Option) (*ssmsap.StopApplicationOutput, error) + StopApplicationRequest(*ssmsap.StopApplicationInput) (*request.Request, *ssmsap.StopApplicationOutput) + TagResource(*ssmsap.TagResourceInput) (*ssmsap.TagResourceOutput, error) TagResourceWithContext(aws.Context, *ssmsap.TagResourceInput, ...request.Option) (*ssmsap.TagResourceOutput, error) TagResourceRequest(*ssmsap.TagResourceInput) (*request.Request, *ssmsap.TagResourceOutput) diff --git a/service/verifiedpermissions/api.go b/service/verifiedpermissions/api.go index 61e57cc59f2..4ad1f7a1623 100644 --- a/service/verifiedpermissions/api.go +++ b/service/verifiedpermissions/api.go @@ -4940,8 +4940,8 @@ func (s *BatchIsAuthorizedWithTokenOutputItem) SetRequest(v *BatchIsAuthorizedWi return s } -// A list of user groups and entities from an Amazon Cognito user pool identity -// source. +// The type of entity that a policy store maps to groups from an Amazon Cognito +// user pool identity source. // // This data type is part of a CognitoUserPoolConfiguration (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CognitoUserPoolConfiguration.html) // structure and is a request parameter in CreateIdentitySource (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreateIdentitySource.html). @@ -4999,8 +4999,8 @@ func (s *CognitoGroupConfiguration) SetGroupEntityType(v string) *CognitoGroupCo return s } -// A list of user groups and entities from an Amazon Cognito user pool identity -// source. +// The type of entity that a policy store maps to groups from an Amazon Cognito +// user pool identity source. // // This data type is part of an CognitoUserPoolConfigurationDetail (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CognitoUserPoolConfigurationItem.html) // structure and is a response parameter to GetIdentitySource (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_GetIdentitySource.html). @@ -5040,8 +5040,8 @@ func (s *CognitoGroupConfigurationDetail) SetGroupEntityType(v string) *CognitoG return s } -// A list of user groups and entities from an Amazon Cognito user pool identity -// source. +// The type of entity that a policy store maps to groups from an Amazon Cognito +// user pool identity source. // // This data type is part of an CognitoUserPoolConfigurationItem (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CognitoUserPoolConfigurationDetail.html) // structure and is a response parameter to ListIdentitySources (http://forums.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListIdentitySources.html). @@ -5088,7 +5088,8 @@ func (s *CognitoGroupConfigurationItem) SetGroupEntityType(v string) *CognitoGro // structure that is used as a parameter to CreateIdentitySource (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreateIdentitySource.html). // // Example:"CognitoUserPoolConfiguration":{"UserPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","ClientIds": -// ["a1b2c3d4e5f6g7h8i9j0kalbmc"]} +// ["a1b2c3d4e5f6g7h8i9j0kalbmc"],"groupConfiguration": {"groupEntityType": +// "MyCorp::Group"}} type CognitoUserPoolConfiguration struct { _ struct{} `type:"structure"` @@ -5098,8 +5099,8 @@ type CognitoUserPoolConfiguration struct { // Example: "ClientIds": ["&ExampleCogClientId;"] ClientIds []*string `locationName:"clientIds" type:"list"` - // The configuration of the user groups from an Amazon Cognito user pool identity - // source. + // The type of entity that a policy store maps to groups from an Amazon Cognito + // user pool identity source. GroupConfiguration *CognitoGroupConfiguration `locationName:"groupConfiguration" type:"structure"` // The Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) @@ -5176,7 +5177,8 @@ func (s *CognitoUserPoolConfiguration) SetUserPoolArn(v string) *CognitoUserPool // structure that is part of the response to GetIdentitySource (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_GetIdentitySource.html). // // Example:"CognitoUserPoolConfiguration":{"UserPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","ClientIds": -// ["a1b2c3d4e5f6g7h8i9j0kalbmc"]} +// ["a1b2c3d4e5f6g7h8i9j0kalbmc"],"groupConfiguration": {"groupEntityType": +// "MyCorp::Group"}} type CognitoUserPoolConfigurationDetail struct { _ struct{} `type:"structure"` @@ -5188,8 +5190,8 @@ type CognitoUserPoolConfigurationDetail struct { // ClientIds is a required field ClientIds []*string `locationName:"clientIds" type:"list" required:"true"` - // The configuration of the user groups from an Amazon Cognito user pool identity - // source. + // The type of entity that a policy store maps to groups from an Amazon Cognito + // user pool identity source. GroupConfiguration *CognitoGroupConfigurationDetail `locationName:"groupConfiguration" type:"structure"` // The OpenID Connect (OIDC) issuer ID of the Amazon Cognito user pool that @@ -5258,7 +5260,8 @@ func (s *CognitoUserPoolConfigurationDetail) SetUserPoolArn(v string) *CognitoUs // structure that is part of the response to ListIdentitySources (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListIdentitySources.html). // // Example:"CognitoUserPoolConfiguration":{"UserPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","ClientIds": -// ["a1b2c3d4e5f6g7h8i9j0kalbmc"]} +// ["a1b2c3d4e5f6g7h8i9j0kalbmc"],"groupConfiguration": {"groupEntityType": +// "MyCorp::Group"}} type CognitoUserPoolConfigurationItem struct { _ struct{} `type:"structure"` @@ -5270,8 +5273,8 @@ type CognitoUserPoolConfigurationItem struct { // ClientIds is a required field ClientIds []*string `locationName:"clientIds" type:"list" required:"true"` - // The configuration of the user groups from an Amazon Cognito user pool identity - // source. + // The type of entity that a policy store maps to groups from an Amazon Cognito + // user pool identity source. GroupConfiguration *CognitoGroupConfigurationItem `locationName:"groupConfiguration" type:"structure"` // The OpenID Connect (OIDC) issuer ID of the Amazon Cognito user pool that @@ -5338,7 +5341,7 @@ func (s *CognitoUserPoolConfigurationItem) SetUserPoolArn(v string) *CognitoUser // At this time, the only valid member of this structure is a Amazon Cognito // user pool configuration. // -// You must specify a userPoolArn, and optionally, a ClientId. +// Specifies a userPoolArn, a groupConfiguration, and a ClientId. // // This data type is used as a request parameter for the CreateIdentitySource // (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreateIdentitySource.html) @@ -5406,7 +5409,8 @@ type ConfigurationDetail struct { // Contains configuration details of a Amazon Cognito user pool that Verified // Permissions can use as a source of authenticated identities as entities. // It specifies the Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) - // of a Amazon Cognito user pool and one or more application client IDs. + // of a Amazon Cognito user pool, the policy store entity that you want to assign + // to user groups, and one or more application client IDs. // // Example: "configuration":{"cognitoUserPoolConfiguration":{"userPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","clientIds": // ["a1b2c3d4e5f6g7h8i9j0kalbmc"],"groupConfiguration": {"groupEntityType": @@ -5448,7 +5452,8 @@ type ConfigurationItem struct { // Contains configuration details of a Amazon Cognito user pool that Verified // Permissions can use as a source of authenticated identities as entities. // It specifies the Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) - // of a Amazon Cognito user pool and one or more application client IDs. + // of a Amazon Cognito user pool, the policy store entity that you want to assign + // to user groups, and one or more application client IDs. // // Example: "configuration":{"cognitoUserPoolConfiguration":{"userPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","clientIds": // ["a1b2c3d4e5f6g7h8i9j0kalbmc"],"groupConfiguration": {"groupEntityType": @@ -5900,11 +5905,20 @@ func (s *CreatePolicyInput) SetPolicyStoreId(v string) *CreatePolicyInput { type CreatePolicyOutput struct { _ struct{} `type:"structure"` + // The action that a policy permits or forbids. For example, {"actions": [{"actionId": + // "ViewPhoto", "actionType": "PhotoFlash::Action"}, {"entityID": "SharePhoto", + // "entityType": "PhotoFlash::Action"}]}. + Actions []*ActionIdentifier `locationName:"actions" type:"list"` + // The date and time the policy was originally created. // // CreatedDate is a required field CreatedDate *time.Time `locationName:"createdDate" type:"timestamp" timestampFormat:"iso8601" required:"true"` + // The effect of the decision that a policy returns to an authorization request. + // For example, "effect": "Permit". + Effect *string `locationName:"effect" type:"string" enum:"PolicyEffect"` + // The date and time the policy was last updated. // // LastUpdatedDate is a required field @@ -5952,12 +5966,24 @@ func (s CreatePolicyOutput) GoString() string { return s.String() } +// SetActions sets the Actions field's value. +func (s *CreatePolicyOutput) SetActions(v []*ActionIdentifier) *CreatePolicyOutput { + s.Actions = v + return s +} + // SetCreatedDate sets the CreatedDate field's value. func (s *CreatePolicyOutput) SetCreatedDate(v time.Time) *CreatePolicyOutput { s.CreatedDate = &v return s } +// SetEffect sets the Effect field's value. +func (s *CreatePolicyOutput) SetEffect(v string) *CreatePolicyOutput { + s.Effect = &v + return s +} + // SetLastUpdatedDate sets the LastUpdatedDate field's value. func (s *CreatePolicyOutput) SetLastUpdatedDate(v time.Time) *CreatePolicyOutput { s.LastUpdatedDate = &v @@ -7306,6 +7332,11 @@ func (s *GetPolicyInput) SetPolicyStoreId(v string) *GetPolicyInput { type GetPolicyOutput struct { _ struct{} `type:"structure"` + // The action that a policy permits or forbids. For example, {"actions": [{"actionId": + // "ViewPhoto", "actionType": "PhotoFlash::Action"}, {"entityID": "SharePhoto", + // "entityType": "PhotoFlash::Action"}]}. + Actions []*ActionIdentifier `locationName:"actions" type:"list"` + // The date and time that the policy was originally created. // // CreatedDate is a required field @@ -7316,6 +7347,10 @@ type GetPolicyOutput struct { // Definition is a required field Definition *PolicyDefinitionDetail `locationName:"definition" type:"structure" required:"true"` + // The effect of the decision that a policy returns to an authorization request. + // For example, "effect": "Permit". + Effect *string `locationName:"effect" type:"string" enum:"PolicyEffect"` + // The date and time that the policy was last updated. // // LastUpdatedDate is a required field @@ -7364,6 +7399,12 @@ func (s GetPolicyOutput) GoString() string { return s.String() } +// SetActions sets the Actions field's value. +func (s *GetPolicyOutput) SetActions(v []*ActionIdentifier) *GetPolicyOutput { + s.Actions = v + return s +} + // SetCreatedDate sets the CreatedDate field's value. func (s *GetPolicyOutput) SetCreatedDate(v time.Time) *GetPolicyOutput { s.CreatedDate = &v @@ -7376,6 +7417,12 @@ func (s *GetPolicyOutput) SetDefinition(v *PolicyDefinitionDetail) *GetPolicyOut return s } +// SetEffect sets the Effect field's value. +func (s *GetPolicyOutput) SetEffect(v string) *GetPolicyOutput { + s.Effect = &v + return s +} + // SetLastUpdatedDate sets the LastUpdatedDate field's value. func (s *GetPolicyOutput) SetLastUpdatedDate(v time.Time) *GetPolicyOutput { s.LastUpdatedDate = &v @@ -8672,7 +8719,7 @@ type ListIdentitySourcesInput struct { // NextToken after every operation to ensure that you receive all of the results. // // If you do not specify this parameter, the operation defaults to 10 identity - // sources per response. You can specify a maximum of 200 identity sources per + // sources per response. You can specify a maximum of 50 identity sources per // response. MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"` @@ -9465,6 +9512,11 @@ func (s *PolicyFilter) SetResource(v *EntityReference) *PolicyFilter { type PolicyItem struct { _ struct{} `type:"structure"` + // The action that a policy permits or forbids. For example, {"actions": [{"actionId": + // "ViewPhoto", "actionType": "PhotoFlash::Action"}, {"entityID": "SharePhoto", + // "entityType": "PhotoFlash::Action"}]}. + Actions []*ActionIdentifier `locationName:"actions" type:"list"` + // The date and time the policy was created. // // CreatedDate is a required field @@ -9475,6 +9527,10 @@ type PolicyItem struct { // Definition is a required field Definition *PolicyDefinitionItem `locationName:"definition" type:"structure" required:"true"` + // The effect of the decision that a policy returns to an authorization request. + // For example, "effect": "Permit". + Effect *string `locationName:"effect" type:"string" enum:"PolicyEffect"` + // The date and time the policy was most recently updated. // // LastUpdatedDate is a required field @@ -9525,6 +9581,12 @@ func (s PolicyItem) GoString() string { return s.String() } +// SetActions sets the Actions field's value. +func (s *PolicyItem) SetActions(v []*ActionIdentifier) *PolicyItem { + s.Actions = v + return s +} + // SetCreatedDate sets the CreatedDate field's value. func (s *PolicyItem) SetCreatedDate(v time.Time) *PolicyItem { s.CreatedDate = &v @@ -9537,6 +9599,12 @@ func (s *PolicyItem) SetDefinition(v *PolicyDefinitionItem) *PolicyItem { return s } +// SetEffect sets the Effect field's value. +func (s *PolicyItem) SetEffect(v string) *PolicyItem { + s.Effect = &v + return s +} + // SetLastUpdatedDate sets the LastUpdatedDate field's value. func (s *PolicyItem) SetLastUpdatedDate(v time.Time) *PolicyItem { s.LastUpdatedDate = &v @@ -10561,8 +10629,7 @@ func (s *ThrottlingException) RequestID() string { return s.RespMetadata.RequestID } -// A list of user groups and entities from an Amazon Cognito user pool identity -// source. +// The user group entities from an Amazon Cognito user pool identity source. type UpdateCognitoGroupConfiguration struct { _ struct{} `type:"structure"` @@ -11079,11 +11146,20 @@ func (s *UpdatePolicyInput) SetPolicyStoreId(v string) *UpdatePolicyInput { type UpdatePolicyOutput struct { _ struct{} `type:"structure"` + // The action that a policy permits or forbids. For example, {"actions": [{"actionId": + // "ViewPhoto", "actionType": "PhotoFlash::Action"}, {"entityID": "SharePhoto", + // "entityType": "PhotoFlash::Action"}]}. + Actions []*ActionIdentifier `locationName:"actions" type:"list"` + // The date and time that the policy was originally created. // // CreatedDate is a required field CreatedDate *time.Time `locationName:"createdDate" type:"timestamp" timestampFormat:"iso8601" required:"true"` + // The effect of the decision that a policy returns to an authorization request. + // For example, "effect": "Permit". + Effect *string `locationName:"effect" type:"string" enum:"PolicyEffect"` + // The date and time that the policy was most recently updated. // // LastUpdatedDate is a required field @@ -11131,12 +11207,24 @@ func (s UpdatePolicyOutput) GoString() string { return s.String() } +// SetActions sets the Actions field's value. +func (s *UpdatePolicyOutput) SetActions(v []*ActionIdentifier) *UpdatePolicyOutput { + s.Actions = v + return s +} + // SetCreatedDate sets the CreatedDate field's value. func (s *UpdatePolicyOutput) SetCreatedDate(v time.Time) *UpdatePolicyOutput { s.CreatedDate = &v return s } +// SetEffect sets the Effect field's value. +func (s *UpdatePolicyOutput) SetEffect(v string) *UpdatePolicyOutput { + s.Effect = &v + return s +} + // SetLastUpdatedDate sets the LastUpdatedDate field's value. func (s *UpdatePolicyOutput) SetLastUpdatedDate(v time.Time) *UpdatePolicyOutput { s.LastUpdatedDate = &v @@ -11844,6 +11932,22 @@ func OpenIdIssuer_Values() []string { } } +const ( + // PolicyEffectPermit is a PolicyEffect enum value + PolicyEffectPermit = "Permit" + + // PolicyEffectForbid is a PolicyEffect enum value + PolicyEffectForbid = "Forbid" +) + +// PolicyEffect_Values returns all elements of the PolicyEffect enum +func PolicyEffect_Values() []string { + return []string{ + PolicyEffectPermit, + PolicyEffectForbid, + } +} + const ( // PolicyTypeStatic is a PolicyType enum value PolicyTypeStatic = "STATIC"