AS2PayloadReceiveCompleted
- class aws_cdk.mixins_preview.aws_transfer.events.AS2PayloadReceiveCompleted
Bases:
object(experimental) EventBridge event pattern for aws.transfer@AS2PayloadReceiveCompleted.
- Stability:
experimental
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_transfer import events as transfer_events a_s2_payload_receive_completed = transfer_events.AS2PayloadReceiveCompleted()
- Stability:
experimental
Static Methods
- classmethod as2_payload_receive_completed_pattern(*, agreement_id=None, as2_from=None, as2_message_id=None, as2_to=None, bytes=None, client_ip=None, end_timestamp=None, event_metadata=None, message_subject=None, requester_file_name=None, request_path=None, s3_attributes=None, server_id=None, start_timestamp=None, status_code=None)
(experimental) EventBridge event pattern for AS2 Payload Receive Completed.
- Parameters:
agreement_id (
Optional[Sequence[str]]) – (experimental) agreement-id property. Specify an array of string values to match this event if the actual value of agreement-id is one of the values in the array. Use one of the constructors on theaws_events.Matchfor more advanced matching options. Default: - Filter with the Agreement referenceas2_from (
Optional[Sequence[str]]) – (experimental) as2-from property. Specify an array of string values to match this event if the actual value of as2-from is one of the values in the array. Use one of the constructors on theaws_events.Matchfor more advanced matching options. Default: - Do not filter on this fieldas2_message_id (
Optional[Sequence[str]]) – (experimental) as2-message-id property. Specify an array of string values to match this event if the actual value of as2-message-id is one of the values in the array. Use one of the constructors on theaws_events.Matchfor more advanced matching options. Default: - Do not filter on this fieldas2_to (
Optional[Sequence[str]]) – (experimental) as2-to property. Specify an array of string values to match this event if the actual value of as2-to is one of the values in the array. Use one of the constructors on theaws_events.Matchfor more advanced matching options. Default: - Do not filter on this fieldbytes (
Optional[Sequence[str]]) – (experimental) bytes property. Specify an array of string values to match this event if the actual value of bytes is one of the values in the array. Use one of the constructors on theaws_events.Matchfor more advanced matching options. Default: - Do not filter on this fieldclient_ip (
Optional[Sequence[str]]) – (experimental) client-ip property. Specify an array of string values to match this event if the actual value of client-ip is one of the values in the array. Use one of the constructors on theaws_events.Matchfor more advanced matching options. Default: - Do not filter on this fieldend_timestamp (
Optional[Sequence[str]]) – (experimental) end-timestamp property. Specify an array of string values to match this event if the actual value of end-timestamp is one of the values in the array. Use one of the constructors on theaws_events.Matchfor more advanced matching options. Default: - Do not filter on this fieldevent_metadata (
Union[AWSEventMetadataProps,Dict[str,Any],None]) – (experimental) EventBridge event metadata. Default: - -message_subject (
Optional[Sequence[str]]) – (experimental) message-subject property. Specify an array of string values to match this event if the actual value of message-subject is one of the values in the array. Use one of the constructors on theaws_events.Matchfor more advanced matching options. Default: - Do not filter on this fieldrequester_file_name (
Optional[Sequence[str]]) – (experimental) requester-file-name property. Specify an array of string values to match this event if the actual value of requester-file-name is one of the values in the array. Use one of the constructors on theaws_events.Matchfor more advanced matching options. Default: - Do not filter on this fieldrequest_path (
Optional[Sequence[str]]) – (experimental) request-path property. Specify an array of string values to match this event if the actual value of request-path is one of the values in the array. Use one of the constructors on theaws_events.Matchfor more advanced matching options. Default: - Do not filter on this fields3_attributes (
Union[S3Attributes,Dict[str,Any],None]) – (experimental) s3-attributes property. Specify an array of string values to match this event if the actual value of s3-attributes is one of the values in the array. Use one of the constructors on theaws_events.Matchfor more advanced matching options. Default: - Do not filter on this fieldserver_id (
Optional[Sequence[str]]) – (experimental) server-id property. Specify an array of string values to match this event if the actual value of server-id is one of the values in the array. Use one of the constructors on theaws_events.Matchfor more advanced matching options. Default: - Do not filter on this fieldstart_timestamp (
Optional[Sequence[str]]) – (experimental) start-timestamp property. Specify an array of string values to match this event if the actual value of start-timestamp is one of the values in the array. Use one of the constructors on theaws_events.Matchfor more advanced matching options. Default: - Do not filter on this fieldstatus_code (
Optional[Sequence[str]]) – (experimental) status-code property. Specify an array of string values to match this event if the actual value of status-code is one of the values in the array. Use one of the constructors on theaws_events.Matchfor more advanced matching options. Default: - Do not filter on this field
- Stability:
experimental
- Return type:
AS2PayloadReceiveCompletedProps
- class AS2PayloadReceiveCompleted.AS2PayloadReceiveCompletedProps(*, agreement_id=None, as2_from=None, as2_message_id=None, as2_to=None, bytes=None, client_ip=None, end_timestamp=None, event_metadata=None, message_subject=None, requester_file_name=None, request_path=None, s3_attributes=None, server_id=None, start_timestamp=None, status_code=None)
Bases:
object(experimental) Props type for aws.transfer@AS2PayloadReceiveCompleted event.
- Parameters:
agreement_id (
Optional[Sequence[str]]) – (experimental) agreement-id property. Specify an array of string values to match this event if the actual value of agreement-id is one of the values in the array. Use one of the constructors on theaws_events.Matchfor more advanced matching options. Default: - Filter with the Agreement referenceas2_from (
Optional[Sequence[str]]) – (experimental) as2-from property. Specify an array of string values to match this event if the actual value of as2-from is one of the values in the array. Use one of the constructors on theaws_events.Matchfor more advanced matching options. Default: - Do not filter on this fieldas2_message_id (
Optional[Sequence[str]]) – (experimental) as2-message-id property. Specify an array of string values to match this event if the actual value of as2-message-id is one of the values in the array. Use one of the constructors on theaws_events.Matchfor more advanced matching options. Default: - Do not filter on this fieldas2_to (
Optional[Sequence[str]]) – (experimental) as2-to property. Specify an array of string values to match this event if the actual value of as2-to is one of the values in the array. Use one of the constructors on theaws_events.Matchfor more advanced matching options. Default: - Do not filter on this fieldbytes (
Optional[Sequence[str]]) – (experimental) bytes property. Specify an array of string values to match this event if the actual value of bytes is one of the values in the array. Use one of the constructors on theaws_events.Matchfor more advanced matching options. Default: - Do not filter on this fieldclient_ip (
Optional[Sequence[str]]) – (experimental) client-ip property. Specify an array of string values to match this event if the actual value of client-ip is one of the values in the array. Use one of the constructors on theaws_events.Matchfor more advanced matching options. Default: - Do not filter on this fieldend_timestamp (
Optional[Sequence[str]]) – (experimental) end-timestamp property. Specify an array of string values to match this event if the actual value of end-timestamp is one of the values in the array. Use one of the constructors on theaws_events.Matchfor more advanced matching options. Default: - Do not filter on this fieldevent_metadata (
Union[AWSEventMetadataProps,Dict[str,Any],None]) – (experimental) EventBridge event metadata. Default: - -message_subject (
Optional[Sequence[str]]) – (experimental) message-subject property. Specify an array of string values to match this event if the actual value of message-subject is one of the values in the array. Use one of the constructors on theaws_events.Matchfor more advanced matching options. Default: - Do not filter on this fieldrequester_file_name (
Optional[Sequence[str]]) – (experimental) requester-file-name property. Specify an array of string values to match this event if the actual value of requester-file-name is one of the values in the array. Use one of the constructors on theaws_events.Matchfor more advanced matching options. Default: - Do not filter on this fieldrequest_path (
Optional[Sequence[str]]) – (experimental) request-path property. Specify an array of string values to match this event if the actual value of request-path is one of the values in the array. Use one of the constructors on theaws_events.Matchfor more advanced matching options. Default: - Do not filter on this fields3_attributes (
Union[S3Attributes,Dict[str,Any],None]) – (experimental) s3-attributes property. Specify an array of string values to match this event if the actual value of s3-attributes is one of the values in the array. Use one of the constructors on theaws_events.Matchfor more advanced matching options. Default: - Do not filter on this fieldserver_id (
Optional[Sequence[str]]) – (experimental) server-id property. Specify an array of string values to match this event if the actual value of server-id is one of the values in the array. Use one of the constructors on theaws_events.Matchfor more advanced matching options. Default: - Do not filter on this fieldstart_timestamp (
Optional[Sequence[str]]) – (experimental) start-timestamp property. Specify an array of string values to match this event if the actual value of start-timestamp is one of the values in the array. Use one of the constructors on theaws_events.Matchfor more advanced matching options. Default: - Do not filter on this fieldstatus_code (
Optional[Sequence[str]]) – (experimental) status-code property. Specify an array of string values to match this event if the actual value of status-code is one of the values in the array. Use one of the constructors on theaws_events.Matchfor more advanced matching options. Default: - Do not filter on this field
- Stability:
experimental
- ExampleMetadata:
fixture=_generated
Example:
from aws_cdk import AWSEventMetadataProps # The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_transfer import events as transfer_events a_s2_payload_receive_completed_props = transfer_events.AS2PayloadReceiveCompleted.AS2PayloadReceiveCompletedProps( agreement_id=["agreementId"], as2_from=["as2From"], as2_message_id=["as2MessageId"], as2_to=["as2To"], bytes=["bytes"], client_ip=["clientIp"], end_timestamp=["endTimestamp"], event_metadata=AWSEventMetadataProps( region=["region"], resources=["resources"], version=["version"] ), message_subject=["messageSubject"], requester_file_name=["requesterFileName"], request_path=["requestPath"], s3_attributes=transfer_events.AS2PayloadReceiveCompleted.S3Attributes( file_bucket=["fileBucket"], file_key=["fileKey"], json_bucket=["jsonBucket"], json_key=["jsonKey"] ), server_id=["serverId"], start_timestamp=["startTimestamp"], status_code=["statusCode"] )
Attributes
- agreement_id
(experimental) agreement-id property.
Specify an array of string values to match this event if the actual value of agreement-id is one of the values in the array. Use one of the constructors on the
aws_events.Matchfor more advanced matching options.- Default:
Filter with the Agreement reference
- Stability:
experimental
- as2_from
(experimental) as2-from property.
Specify an array of string values to match this event if the actual value of as2-from is one of the values in the array. Use one of the constructors on the
aws_events.Matchfor more advanced matching options.- Default:
Do not filter on this field
- Stability:
experimental
- as2_message_id
(experimental) as2-message-id property.
Specify an array of string values to match this event if the actual value of as2-message-id is one of the values in the array. Use one of the constructors on the
aws_events.Matchfor more advanced matching options.- Default:
Do not filter on this field
- Stability:
experimental
- as2_to
(experimental) as2-to property.
Specify an array of string values to match this event if the actual value of as2-to is one of the values in the array. Use one of the constructors on the
aws_events.Matchfor more advanced matching options.- Default:
Do not filter on this field
- Stability:
experimental
- bytes
(experimental) bytes property.
Specify an array of string values to match this event if the actual value of bytes is one of the values in the array. Use one of the constructors on the
aws_events.Matchfor more advanced matching options.- Default:
Do not filter on this field
- Stability:
experimental
- client_ip
(experimental) client-ip property.
Specify an array of string values to match this event if the actual value of client-ip is one of the values in the array. Use one of the constructors on the
aws_events.Matchfor more advanced matching options.- Default:
Do not filter on this field
- Stability:
experimental
- end_timestamp
(experimental) end-timestamp property.
Specify an array of string values to match this event if the actual value of end-timestamp is one of the values in the array. Use one of the constructors on the
aws_events.Matchfor more advanced matching options.- Default:
Do not filter on this field
- Stability:
experimental
- event_metadata
(experimental) EventBridge event metadata.
- Default:
- Stability:
experimental
- message_subject
(experimental) message-subject property.
Specify an array of string values to match this event if the actual value of message-subject is one of the values in the array. Use one of the constructors on the
aws_events.Matchfor more advanced matching options.- Default:
Do not filter on this field
- Stability:
experimental
- request_path
(experimental) request-path property.
Specify an array of string values to match this event if the actual value of request-path is one of the values in the array. Use one of the constructors on the
aws_events.Matchfor more advanced matching options.- Default:
Do not filter on this field
- Stability:
experimental
- requester_file_name
(experimental) requester-file-name property.
Specify an array of string values to match this event if the actual value of requester-file-name is one of the values in the array. Use one of the constructors on the
aws_events.Matchfor more advanced matching options.- Default:
Do not filter on this field
- Stability:
experimental
- s3_attributes
(experimental) s3-attributes property.
Specify an array of string values to match this event if the actual value of s3-attributes is one of the values in the array. Use one of the constructors on the
aws_events.Matchfor more advanced matching options.- Default:
Do not filter on this field
- Stability:
experimental
- server_id
(experimental) server-id property.
Specify an array of string values to match this event if the actual value of server-id is one of the values in the array. Use one of the constructors on the
aws_events.Matchfor more advanced matching options.- Default:
Do not filter on this field
- Stability:
experimental
- start_timestamp
(experimental) start-timestamp property.
Specify an array of string values to match this event if the actual value of start-timestamp is one of the values in the array. Use one of the constructors on the
aws_events.Matchfor more advanced matching options.- Default:
Do not filter on this field
- Stability:
experimental
- status_code
(experimental) status-code property.
Specify an array of string values to match this event if the actual value of status-code is one of the values in the array. Use one of the constructors on the
aws_events.Matchfor more advanced matching options.- Default:
Do not filter on this field
- Stability:
experimental
S3Attributes
- class AS2PayloadReceiveCompleted.S3Attributes(*, file_bucket=None, file_key=None, json_bucket=None, json_key=None)
Bases:
object(experimental) Type definition for S3-attributes.
- Parameters:
file_bucket (
Optional[Sequence[str]]) – (experimental) file-bucket property. Specify an array of string values to match this event if the actual value of file-bucket is one of the values in the array. Use one of the constructors on theaws_events.Matchfor more advanced matching options. Default: - Do not filter on this fieldfile_key (
Optional[Sequence[str]]) – (experimental) file-key property. Specify an array of string values to match this event if the actual value of file-key is one of the values in the array. Use one of the constructors on theaws_events.Matchfor more advanced matching options. Default: - Do not filter on this fieldjson_bucket (
Optional[Sequence[str]]) – (experimental) json-bucket property. Specify an array of string values to match this event if the actual value of json-bucket is one of the values in the array. Use one of the constructors on theaws_events.Matchfor more advanced matching options. Default: - Do not filter on this fieldjson_key (
Optional[Sequence[str]]) – (experimental) json-key property. Specify an array of string values to match this event if the actual value of json-key is one of the values in the array. Use one of the constructors on theaws_events.Matchfor more advanced matching options. Default: - Do not filter on this field
- Stability:
experimental
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_transfer import events as transfer_events s3_attributes = transfer_events.AS2PayloadReceiveCompleted.S3Attributes( file_bucket=["fileBucket"], file_key=["fileKey"], json_bucket=["jsonBucket"], json_key=["jsonKey"] )
Attributes
- file_bucket
(experimental) file-bucket property.
Specify an array of string values to match this event if the actual value of file-bucket is one of the values in the array. Use one of the constructors on the
aws_events.Matchfor more advanced matching options.- Default:
Do not filter on this field
- Stability:
experimental
- file_key
(experimental) file-key property.
Specify an array of string values to match this event if the actual value of file-key is one of the values in the array. Use one of the constructors on the
aws_events.Matchfor more advanced matching options.- Default:
Do not filter on this field
- Stability:
experimental
- json_bucket
(experimental) json-bucket property.
Specify an array of string values to match this event if the actual value of json-bucket is one of the values in the array. Use one of the constructors on the
aws_events.Matchfor more advanced matching options.- Default:
Do not filter on this field
- Stability:
experimental
- json_key
(experimental) json-key property.
Specify an array of string values to match this event if the actual value of json-key is one of the values in the array. Use one of the constructors on the
aws_events.Matchfor more advanced matching options.- Default:
Do not filter on this field
- Stability:
experimental